webhooks
3 endpoints
get /webhooks
List outbound webhooks
Requires authentication
Returns the org's outbound webhook subscriptions (signing secrets are never included).
Responses
- 200 OK · object
- 403 Forbidden · apimodel.ErrorEnvelope
post /webhooks
Create an outbound webhook
Requires authentication
Registers a new subscription. The signing secret is returned ONCE here and never again.
Request body: apimodel.CreateWebhookRequest
| Name | Type | Required | Description |
|---|---|---|---|
| events | string[] | no | |
| projectId | integer | no | |
| url | string | no |
Responses
- 200 OK · object
- 400 Invalid body, or a url that is not https or targets an internal address · apimodel.ErrorEnvelope
- 403 Forbidden · apimodel.ErrorEnvelope
delete /webhooks/{id}
Delete an outbound webhook
Requires authentication
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Webhook id |
Responses
- 200 OK · object
- 400 Bad Request · apimodel.ErrorEnvelope
- 404 Not Found · apimodel.ErrorEnvelope