Rotate a webhook's signing secret
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`.
/v1/orgs/{org}/webhooks/{webhook}/rotate-secretA 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.
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/rotate-secret"{ "id": "string", "url": "string", "events": [ "string" ], "description": "string", "enabled": true, "disabled_reason": "string", "previous_secret_expires_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "secret": "string"}Change a webhook PATCH
Its URL, events, description, or whether it is on; turning it on again clears why Synq turned it off. It receives only events recorded while it is on and wants them: nothing recorded while it was off is sent once it is on again, and a newly wanted event only from the change on. Needs `org.webhooks.edit`. Changing its URL or events, or turning it on, also wants a plan with webhooks (403 `plan_feature_unavailable`), so an org that moved to a plan without them can still turn one off, describe it or delete it. Recorded as `webhook.updated`.
Send a test event POST
A `webhook.test` event, sent now, once, signed like any other; the answer says how the receiver took it. Needs `org.webhooks.edit`.