Synq Docs
Management APIWebhooks

Change a webhook

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`.

PATCH/v1/orgs/{org}/webhooks/{webhook}

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.

Authorization

bearer
AuthorizationBearer <token>

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

org*string
webhook*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/orgs/string/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}