bymundi API

List webhook endpoints

GET/v1/webhook-endpoints

Lists the webhook endpoints that belong to this key, newest first.

Permissions: any valid key · Kind: read · Cost: 1 unit

Path parameters

None.

Query parameters

None.

Response 200

Field Type Required Description
object "list" yes
data object[] yes
data[].object "webhook_endpoint" yes
data[].id uuid yes
data[].url string yes
data[].description string yes
data[].eventTypes "trip.created" | "trip.updated" | "trip.archived" | "trip.restored" | "trip.published" | "trip.unpublished" | "trip.deleted" | "trip.itinerary.updated" | "quote.created" | "quote.updated" | "quote.sent" | "quote.accepted" | "quote.rejected" | "quote.deleted" | "traveler.added" | "traveler.updated" | "traveler.removed" | "trip.contact.updated" | "document.created" | "document.updated" | "document.deleted"[] yes
data[].enabled boolean yes
data[].disabledReason "manual" | "failing" | "key_invalid" | null yes Why it is off: switched off by a person, failing for 3 days, or its key is no longer usable.
data[].keyId uuid yes The API key it belongs to; its events are read with this key's permissions.
data[].previousSecretExpiresAt string | null yes After a rotation, the old secret keeps signing until this moment.
data[].lastSuccessAt string | null yes
data[].failingSince string | null yes
data[].createdAt string yes
data[].updatedAt string yes
nextCursor string | null yes

Errors

Errors are problem details. Besides the refusals described above, any call like this one can return: