EmailGuard

API reference

Download spec
post

Create notification channel

Creates a delivery channel for the team. Email channels require verification; webhook channels can be verified with the test endpoint.

Required API key scope
notifications:create
/api/v1/team/notifications/channels

Code samples

curl --request POST \
  --url https://api.emailguard.co/api/v1/team/notifications/channels \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Parameters

Request body

Channel name, type, and type-specific configuration

configobject

Type-specific configuration (email address, webhook URL, headers, and so on).

namestringrequired

Display name shown in team notification settings.

typestringrequired

Channel type (for example email or webhook).

Responses

200
OK
OK
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

configobject

Type-specific configuration. Sensitive values may be redacted in responses.

created_atstring

When the channel was created (RFC3339).

idstring

Channel record ID.

is_verifiedboolean

Whether the channel has completed verification (email link or webhook test).

namestring

Display name in notification settings.

typestring

Channel type (for example email or webhook).

messagestring

Human-readable detail when the code is not OK.

400
Bad Request
Bad Request
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

401
Unauthorized
Unauthorized
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

403
Forbidden
Forbidden
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.