Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

deliveries

Every deliveries endpoint, generated from the API's own schemas.

What happened to each event we tried to hand you

get/api/v1/deliveries

`webhook_id` is required — the question is always about one endpoint. The ids here are what the replay below takes.

Parameters

  • webhook_iduuidrequired
  • limitnumber

Responses

  • 200A page of attempts.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/deliveries \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json

Send it again

post/api/v1/deliveries/{id}/replay

Re-queues one attempt and resets its count. A verb rather than a status field, because the other statuses are ours to write and mean nothing coming from outside.

Parameters

  • idstringrequired

Responses

  • 200Queued.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/deliveries/{id}/replay \
  -X POST \
  -H "Authorization: Bearer $PIDGEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Generated · public/openapi.json