Docs
Create Receiver
POST /receivers
POST
/receiversCreates an email or webhook receiver that gets notifications for an organization or an event. ownerScope is organization or event (with ownerEventId). Email needs emailAddress; webhook needs webhookUrl, which is checked before saving. filterEventTypes limits which event types are sent (empty sends all). The webhook secret is returned here once; read it from this response. Needs the notifications manage receivers permission on the organization or event.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Optional | |
| channelType | string | Optional | |
| ownerScope | string | Optional | |
| ownerOrganizationId | uuid | Optional | |
| ownerEventId | uuid | Optional | |
| emailAddress | string | Optional | |
| webhookUrl | string | Optional | |
| filterEventTypes | string[] | Optional |
Response
| Field | Type | Description |
|---|---|---|
| id | uuid | |
| name | string| null | |
| channelType | string| null | |
| ownerScope | string| null | |
| ownerOrganizationId | uuid | |
| ownerEventId | uuid| null | |
| emailAddress | string| null | |
| webhookUrl | string| null | |
| secret | string| null | |
| filterEventTypes | string[]| null | |
| isActive | boolean | |
| createdByUserId | uuid | |
| createdAt | date-time | |
| updatedAt | date-time |