Webhooks

Create a webhook

Subscribe an https endpoint to events, for one board or every board in the workspace. The answer carries the signing secret, once. Events are sent only about boards the webhook's creator can open. Use this from an integration that subscribes on behalf of its user, such as a Zapier trigger, and delete the webhook when the user turns the trigger off.

post/webhooks

Request

Base URL
https://api.mockflow.com/v1
Auth
HTTP bearer

Request body

urlstring uri required

Where to send events. https, to a public host.

eventsstring[] required

Event types from GET /webhooks/events, a family such as "item.", or "" for all.

boardIdstring nullable

One board only. Leave out for every board in the workspace.

descriptionstring

Response

Created. secret is shown here and when it is rotated, never in a list.

idstring

urlstring uri

eventsstring[]

boardIdstring nullable

Null for every board in the workspace.

descriptionstring

activeboolean

pausedReasonstring nullable

Why MockFlow paused it

createdBystring nullable

Events are sent only about boards this person can open.

createdAtstring date-time

updatedAtstring date-time nullable

secretstring

Example response

{
  "id": "whk_9fa2",
  "events": [
    "board.created",
    "member.*"
  ],
  "secret": "whsec_4kT2pQ"
}

Changes

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