Create a webhook
post
https://api.flactrum.com/v1/webhooks
The signing secret is returned once, in this response only. It is stored encrypted; a secret that could be read back would not be a secret.
| Required scope | webhooks.write |
| Success status | 201 |
| Returns | One Webhook object |
Request body
| Field | Type | Description |
|---|---|---|
| name * | string | — |
| url * | string | Must be https — a signed payload should not travel over plain HTTP. |
| scope * | string | — |
| branch_id | string|null | Required when scope is branch. |
| region | string|null | Required when scope is region. |
| events * | array | At least one. Valid values come from /webhook-events. |
| is_active | boolean | — |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | — |
| name | string | — |
| url | string | — |
| scope | string | — |
| branch_id | string|null | — |
| region | string|null | — |
| is_active | boolean | — |
| events | array | — |
| failure_count | integer | Consecutive failures. Editing the endpoint resets it. |
| last_delivered_at | string|null | — |
| last_error | string|null | — |
| secret | string | Only present in the create and rotate responses. Stored encrypted; never returned again. |
Examples
No recorded example yet.