Update a webhook subscription
Partial update; at least one field is required. `status` accepts only the admin-controllable transitions `active` and `paused` — setting `active` on a `failedOut` subscription re-enables it and clears `failedOutAt` / `failedOutReason`. Pass `expiresAt: null` to clear an expiry. URL and event changes go through the same checks as create.
Partial update; at least one field is required. status accepts only the admin-controllable transitions active and paused — setting active on a failedOut subscription re-enables it and clears failedOutAt / failedOutReason. Pass expiresAt: null to clear an expiry. URL and event changes go through the same checks as create.
Authorization
bearerAuth In: header
Path Parameters
Unique identifier of the workspace.
uuidWebhook subscription ID.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
1 <= propertiesResponse Body
application/json
application/json
curl -X PATCH "https://example.com/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c", "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "name": "string", "url": "http://example.com", "events": [ "task.created" ], "status": "active", "failedOutAt": "2019-08-24T14:15:22Z", "failedOutReason": "string", "expiresAt": "2019-08-24T14:15:22Z", "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9", "lastDeliveryAt": "2019-08-24T14:15:22Z", "lastSuccessAt": "2019-08-24T14:15:22Z", "lastFailureAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}