List deliveries

GET /webhooks/{webhookId}/deliveries

Updated 8 Oct 20262 min read

GET/webhooks/{webhookId}/deliveriesTry it

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

Request

curl https://api.mockflow.com/v1/webhooks/whk_9fa2/deliveries \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY"

const response = await fetch("https://api.mockflow.com/v1/webhooks/whk_9fa2/deliveries", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`
  }
});

const data = await response.json();

import os, requests

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

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

Response

{
  "data": [
    {
      "id": "dlv_7hd2",
      "webhookId": "string",
      "callbackUrl": "string",
      "jobId": "job_7hd2",
      "eventId": "evt_51ac",
      "eventType": "board.created"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

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

The last seven days of deliveries for this webhook, newest first, each with its payload and the endpoint's answer.

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

Query parameters

limitintegerquery

Defaults to 50.

cursorstringquery

The nextCursor of the previous page.

Response

200 · application/json

dataWebhookDelivery[]

Child attributes

idstring

webhookIdstring | null

Null for a callbackUrl delivery.

callbackUrlstring | null

Set for a callbackUrl delivery.

jobIdstring | null

The job a callbackUrl delivery reported.

eventIdstring

eventTypestring

statusenum<string>

One of pending, retrying, succeeded, failed or cancelled.

attemptsinteger

responseStatusinteger | null

The HTTP status the endpoint answered.

durationMsinteger | null

errorstring | null

nextRetryAtstring | null

deliveredAtstring | null

replayOfstring | null

createdAtstring

payloadWebhookEvent

The body of every delivery. Headers: MockFlow-Event-Id, MockFlow-Event-Type, MockFlow-Delivery-Id, MockFlow-Webhook-Id (not on callbacks) and MockFlow-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of "t.body" with the secret>.

hasMoreboolean

nextCursorstring | null

Errors

429rate_limited

Too many requests.

Was this page helpful?