EmailGuard

API reference

Download spec
post

Test notification channel

Sends a sample payload to a webhook channel to confirm the endpoint is reachable. On success the channel is marked verified.

Required API key scope
notifications:update
/api/v1/team/notifications/channels/{channelId}/test

Code samples

curl --request POST \
  --url https://api.emailguard.co/api/v1/team/notifications/channels/YOUR_ID/test \
  --header 'Authorization: Bearer YOUR_API_KEY'

Parameters

Path parameters

NameTypeDescription
channelIdrequiredstring

UUID of the webhook channel to test

Responses

200
OK
OK
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.