POST
/
notifications
/
channels
curl --request POST \
  --url https://api.pxyz.dev/api/v0/notifications/channels \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "<string>",
  "name": "<string>",
  "key": "<string>",
  "description": "<string>",
  "type": "email",
  "provider": "email_pxyz",
  "providerSettings": {}
}'
{
  "id": "<string>",
  "tenantId": "<string>",
  "name": "<string>",
  "key": "<string>",
  "description": "<string>",
  "type": "email",
  "provider": "email_pxyz",
  "enabled": true,
  "providerSettings": "<any>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
tenantId
string
required
name
string
required
key
string
required
description
string | null
type
enum<string>
required
Available options:
email,
sms,
push,
webhook,
inapp,
chat
provider
enum<string>
required
Available options:
email_pxyz,
email_aws_ses,
email_mailgun,
email_mailjet,
email_mailersend,
email_mailtrap,
email_mandrill,
email_postmark,
email_sendgrid,
email_sparkpost,
email_resend,
inapp_pxyz,
push_firebase,
push_apns,
push_expo,
sms_pxyz,
sms_twilio,
sms_telnyx,
sms_mailersend,
sms_messagebird,
sms_africas_talking,
sms_vonage,
sms_sinch,
sms_aws_sns,
sms_plivo,
chat_slack,
chat_microsoft_teams,
chat_discord,
chat_whatsapp,
webhook
providerSettings
object
required

Response

200 - application/json
id
string
required
tenantId
string
required
name
string
required
key
string
required
description
string | null
required
type
enum<string>
required
Available options:
email,
sms,
push,
webhook,
inapp,
chat
provider
enum<string>
required
Available options:
email_pxyz,
email_aws_ses,
email_mailgun,
email_mailjet,
email_mailersend,
email_mailtrap,
email_mandrill,
email_postmark,
email_sendgrid,
email_sparkpost,
email_resend,
inapp_pxyz,
push_firebase,
push_apns,
push_expo,
sms_pxyz,
sms_twilio,
sms_telnyx,
sms_mailersend,
sms_messagebird,
sms_africas_talking,
sms_vonage,
sms_sinch,
sms_aws_sns,
sms_plivo,
chat_slack,
chat_microsoft_teams,
chat_discord,
chat_whatsapp,
webhook
enabled
boolean
required
providerSettings
any
createdAt
string
required
updatedAt
string
required