Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

Webhooks

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

List webhooks

get/api/v1/webhooks

Parameters

  • limitnumber
  • cursordate-time

Responses

  • 200A page of webhooks.
  • 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/webhooks \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json

Create a webhook

post/api/v1/webhooks

The signing secret is returned once, here, and never again. Every delivery is signed with it as HMAC-SHA256.

Body

  • urlurirequired
  • identity_iduuid | null
  • event_typesenum[]

Responses

  • 201The webhook.
  • 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/webhooks \
  -X POST \
  -H "Authorization: Bearer $PIDGEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Generated · public/openapi.json

Delete a webhook

delete/api/v1/webhooks/{id}

Parameters

  • idstringrequired

Responses

  • 204Deleted. No body.
  • 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/webhooks/{id} \
  -X DELETE \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json