Create Webhook Endpoint
Create a webhook endpoint. Caller must hold webhooks:manage in body.org_id.
The generated secret is returned in plaintext exactly once - callers must store it immediately, it cannot be retrieved again afterward.
Authorization
OAuth2AuthorizationCodeBearer AuthorizationBearer <token>
In: header
Query Parameters
verify_locally?Verify Locally
Default
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "target_url": "string", "event_types": [ "string" ] }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "target_url": "string", "is_active": true, "description": "string", "event_types": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "secret": "string"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}