Webhooks

Create a webhook subscription (admin only)

For generic provider webhooks, the response includes a one-time signingSecret — capture it; the secret cannot be retrieved later.

post/v1/webhooks

Request

  • Base URL: https://app.getdealboard.com
  • URL: https://app.getdealboard.com/v1/webhooks
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional client-chosen string. If the same key is sent twice within 24h with the same body, the original response is replayed.

Request body

boardIdstring uuid required
urlstring required
labelstring nullable
eventsstring[] required
stageFilterstring[]

Stage IDs (from this board) to filter stage_changed events. Empty = all stages.

Response

Created

idstring uuid required
boardIdstring uuid required
labelstring nullable required
urlFingerprintstring required

Last 4 characters of the URL. The URL itself is a secret and is never returned.

provider'slack' | 'teams' | 'discord' | 'generic' required
eventsstring[] required
stageFilterstring[] required

Stage IDs (per-board) to filter deal.stage_changed events to. Empty = all stages.

activeboolean required
createdAtstring date-time required
lastDeliveredAtstring date-time nullable required
lastErrorstring nullable required
signingSecretstring nullable

Non-null only for generic provider. Shown exactly once.

Changes

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