Enable a webhook
Turn a webhook on, clearing why Synq turned it off and its consecutive failures when it was off. Events recorded while it was off are not sent. Needs `org.webhooks.edit` and a plan with webhooks (403 `plan_feature_unavailable` otherwise). Recorded as `webhook.updated` with enabled in its fields.
/v1/orgs/{org}/webhooks/{webhook}/enableTurn a webhook on, clearing why Synq turned it off and its consecutive failures when it was off. Events recorded while it was off are not sent. Needs org.webhooks.edit and a plan with webhooks (403 plan_feature_unavailable otherwise). Recorded as webhook.updated with enabled in its fields.
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
The org's id
^org_[0-9a-hjkmnp-tv-z]{26}$The webhook's id
^whk_[0-9a-hjkmnp-tv-z]{26}$Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/webhooks/whk_01h455vb4pex5vsknk084sn02q/enable" \ -H "Authorization: Bearer $SYNQ_API_KEY"{ "id": "whk_01h455vb4pex5vsknk084sn02q", "url": "https://app.acme.example", "events": [ "string" ], "name": "Order sync", "description": "string", "enabled": true, "disabled_reason": "string", "previous_secret_expires_at": "2026-10-21T12:00:00.000Z", "brands": [ "brd_01h455vb4pex5vsknk084sn02q" ], "created_at": "2026-10-21T12:00:00.000Z"}Disable a webhook POST
Turn a webhook off. Its deliveries still waiting, those being tried again after a failed attempt among them, are `failed` at once, with `last_error` saying the webhook was turned off: turning it on sends none of them, nor any event recorded while it was off, and each can be sent again by hand (`POST …/deliveries/{delivery}/resend`) once it is on. An org whose plan no longer includes webhooks can still stop its subscriptions. Needs `org.webhooks.edit`. Recorded as `webhook.updated` with enabled in its fields.
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`. A person needs a sign-in at Synq from the last 5 minutes whose time Synq proved (send them to sign in with `max_age=300`), else 403 `fresh_sign_in_required`; an API key never does. Recorded as `webhook.secret_rotated`.