Webhooks

Update Webhook

Update webhook fields.

patch/v1/webhooks/{webhook_id}

Request

  • Base URL: https://api.pinbridge.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.pinbridge.io/v1/webhooks/{webhook_id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

webhook_idstring uuid required

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

urlstring uri nullable

Webhook endpoint URL

secretstring nullable

Secret for HMAC signing (min 16 chars)

eventsstring[] nullable

Event types to subscribe to

is_enabledboolean nullable

Whether this webhook is active

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
urlstring required
eventsstring[] required
is_enabledboolean required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.