Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

Events

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

List events

get/api/v1/events

The same events a webhook delivers, readable after the fact — so a missed delivery is recoverable without replaying anything.

Parameters

  • limitnumber
  • cursordate-time
  • typestring
  • identity_iduuid

Responses

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

Generated · public/openapi.json

Fetch one event

get/api/v1/events/{id}

Parameters

  • idstringrequired

Responses

  • 200The event.
  • 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/events/{id} \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json