Webhooks

Create Webhook

Create a new webhook endpoint.

Webhooks receive events like pin.published and pin.failed.

post/v1/webhooks

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
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

urlstring uri required

Webhook endpoint URL

secretstring required

Secret for HMAC signing (min 16 chars)

eventsstring[]

Event types to subscribe to

is_enabledboolean

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.