Update a webhook subscription

Board admins on Pro boards only (authz via subscription lookup). Partial update - send only the fields to change. A downgraded (Free) board gets 402 here; DELETE stays open so it can still clean up.

patch/webhooks/{id}

Request

  • Base URL: https://craaft.io/api/v1
  • URL: https://craaft.io/api/v1/webhooks/{id}
  • Auth: HTTP bearer

Request body

urlstring uri
descriptionstring
format'craaft' | 'slack' | 'discord'
eventsstring[]
activeboolean

Response

Updated

idstring uuid required

Subscription id (the handle for update/delete)

endpointIdstring uuid required

Endpoint id at the workspace level

urlstring uri required

The target URL for deliveries

secretstring required

HMAC signing secret for 'craaft' deliveries (X-Craaft-Signature). Returned on every read to board admins. Slack/Discord deliveries are unsigned and ignore it.

descriptionstring required

Optional label

format'craaft' | 'slack' | 'discord' required

Delivery format (craaft=signed JSON envelope; slack/discord=message POST)

eventsstring[] required

Event filter (empty=all events; non-empty=only listed events)

activeboolean required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.