Send a test event
A `webhook.test` event, sent now, once, signed like any other; the answer says how the receiver took it. Needs `org.webhooks.edit`.
/v1/orgs/{org}/webhooks/{webhook}/testA webhook.test event, sent now, once, signed like any other; the answer says how the receiver took it. Needs org.webhooks.edit.
Authorization
bearer An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.
In: header
Path Parameters
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/orgs/string/webhooks/string/test"{ "id": "string", "event_type": "string", "status": "pending", "attempts": 0, "last_status_code": 0, "last_error": "string", "delivered_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z"}Rotate a webhook's signing secret POST
A new secret, in this response only. For 24 hours deliveries carry signatures by both, so the receiver can switch over. Needs `org.webhooks.edit`. Recorded as `webhook.secret_rotated`.
Subscribe a URL to events POST
An https URL on the public internet. The signing secret is in this response only. It receives only events recorded after it exists and while it is on. Needs `org.webhooks.edit`, and a plan with webhooks (403 `plan_feature_unavailable` otherwise, naming the plan in `required_plan`). Recorded as `webhook.created`.