Update a webhook

PATCH /webhooks/{webhookId}

Updated 8 Oct 20261 min read

PATCH/webhooks/{webhookId}Try it

Basehttps://api.mockflow.com/v1Scopesboards:read

Request

curl https://api.mockflow.com/v1/webhooks/whk_9fa2 \
  -X PATCH \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "active": true
}'

const response = await fetch("https://api.mockflow.com/v1/webhooks/whk_9fa2", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "active": true
})
});

const data = await response.json();

import os, requests

response = requests.patch(
    "https://api.mockflow.com/v1/webhooks/whk_9fa2",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "active": True
},
)

response.raise_for_status()
data = response.json()

Response

{
  "id": "whk_9fa2",
  "url": "https://app.mockflow.com/board/brd_3f9e2a",
  "events": [
    "board.created",
    "member.*"
  ],
  "boardId": "brd_3f9e2a",
  "description": "string",
  "active": false
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}

Change where it sends, what it sends or whether it is on. Turning a paused webhook back on clears the pause. Whoever edits a webhook becomes its creator, so its events follow their access.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs boards:read scope. Create and manage keys in the developer console, or use an OAuth app to act for other people; what each scope unlocks is on the scopes page.

Path parameters

webhookIdstringpathrequired

Body

application/json

urlstring

eventsstring[]

boardIdstring | null

descriptionstring

activeboolean

Response

200 · application/json

idstring

urlstring

eventsstring[]

boardIdstring | null

Null for every board in the workspace.

descriptionstring

activeboolean

pausedReasonstring | null

Why MockFlow paused it

createdBystring | null

Events are sent only about boards this person can open.

createdAtstring

updatedAtstring | null

Errors

429rate_limited

Too many requests.

Was this page helpful?