Create Webhook
POST {{baseUrl}}/api/webhooks/
Create a new Webhook
Rate limits:
Burst: 1/s
Steady: 15/m
Scopes:
webhooks:write
Request Body
{"data"=>{"type"=>"webhook", "attributes"=>{"name"=>"<string>", "endpoint_url"=>"<string>", "secret_key"=>"<string>", "description"=>"<string>"}, "relationships"=>{"webhook-topics"=>{"data"=>[{"type"=>"webhook-topic", "id"=>"<string>"}, {"type"=>"webhook-topic", "id"=>"<string>"}]}}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data":{"type":"webhook","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","endpoint_url":"\u003cstring\u003e","enabled":"\u003cboolean\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","description":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"webhook-topics":{"data":[{"type":"webhook-topic","id":"\u003cstring\u003e"},{"type":"webhook-topic","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}