pydo.insights.create_notification_channel()
Generated on 13 Nov 2026
from pydo version
v0.46.0
Usage
client.insights.create_notification_channel(
body={
"name": "Platform alerts",
"email": {...},
"slack": {...},
...,
},
)Description
To create a notification channel, send a POST request to
/v2/insights/notification-channels with a name and exactly one of
email, slack, or webhook.
Email recipients must be team contact emails added and verified by a team
owner. Webhook URLs must
use HTTPS. Secret fields (slack.webhook_url, webhook credentials) are
write-only. Subsequent reads never return secret values; they include
optional *_status objects when a secret is configured.
Parameters
namestring requiredExample:
Platform alertsA human-readable name for the notification channel.
emailobject optionalEmail notification channel configuration. Recipients must be team contact
emails added and verified by a team owner. They do not need to be team
members.Show child properties
tostring requiredExample:
[email protected], [email protected]One or more recipient email addresses, separated by commas, semicolons,
or spaces.
slackobject optionalSlack notification channel configuration for create and update requests.
webhook_urlis write-only: send the full value to set or rotate. Omitwebhook_urlon update to keep the existing secret.Show child properties
webhook_urlstring optionalExample:
https://hooks.slack.com/services/T000/B000/XXXXXXXXSlack incoming webhook URL. Write-only secret — send the full value on
create or update. Omit on update to retain the existing value. Never
returned in responses.channelstring requiredExample:
#platform-alertsThe Slack channel name to notify.
webhookobject optionalGeneric HTTPS webhook notification channel configuration for create and
update requests. The URL must use HTTPS and must not include userinfo.
Optionally configure eitherbasic_authorbearer_token(not both),
custom headers, and a signing secret.urlis not a secret and is returned in full on read. Credential fields
(basic_auth.password,bearer_token.token,signature.secret) are
write-only: send the full value to set or rotate. Omit a secret field on
update to keep the existing value. Responses return nested*_status
objects instead of secret values.Show child properties
urlstring requiredExample:
https://example.com/hookHTTPS URL that receives webhook deliveries. Returned in full on read.
basic_authobject optionalHTTP basic authentication credentials for a webhook create or update
request.passwordis write-only: send the full value to set or rotate.
Omitpasswordon update to keep the existing password.Show child properties
usernamestring requiredExample:
webhook-userBasic auth username.
passwordstring optionalExample:
secret-passwordBasic auth password. Write-only secret — send the full value on create
or update. Omit on update to retain the existing value. Never returned
in responses.
bearer_tokenobject optionalBearer token authentication for a webhook create or update request.
token
is write-only: send the full value to set or rotate. Omittokenon update
to keep the existing token.Show child properties
tokenstring optionalExample:
secret-tokenBearer token value sent in the Authorization header. Write-only secret —
send the full value on create or update. Omit on update to retain the
existing value. Never returned in responses.
headersobject optionalExample:
{'X-Custom': '1'}Optional custom HTTP headers to include on webhook deliveries. At most
20 headers are allowed. Reserved header names such ashost,content-type, andproxy-*are rejected.signatureobject optionalOptional HMAC signature configuration for a webhook create or update
request.secretis write-only: send the full value to set or rotate. Omitsecreton update to keep the existing secret.Show child properties
secretstring optionalExample:
whsecShared secret used to sign webhook payloads. Write-only secret — send
the full value on create or update. Omit on update to retain the
existing value. Never returned in responses.
Request Sample
Response Example
More Information
See /v2/insights/notification-channels in the API reference for additional detail on responses, headers, parameters, and more.