Event Deliveries

List all event deliveries

Changed on

This endpoint retrieves all event deliveries paginated.

get/v1/projects/{projectID}/eventdeliveries

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project ID

Query parameters

direction'next' | 'prev'
endDatestring

The end date

endpointIdstring[]

A list of endpoint IDs to filter by

eventIdstring

Event ID to filter by

eventTypestring

EventType to filter by

idempotencyKeystring

IdempotencyKey to filter by

idempotencyValuestring

Raw value of a source's single idempotency key location, e.g. a provider delivery ID. Matches deliveries of events ingested with it. Not combinable with idempotencyKey.

minTrialsinteger

Only return deliveries with at least this many attempts; 2 or more means retried. Requires idempotencyValue, eventId, or endpointId.

next_page_cursorstring

A pagination cursor to fetch the next page of a list

perPageinteger

The number of items to return per page

prev_page_cursorstring

A pagination cursor to fetch the previous page of a list

querystring

Matches delivery id, event id, event type prefix, and endpoint name.

sortstring

Sort order, values are ASC or DESC, defaults to DESC

sourceIdstring[]

Limits idempotencyValue matching to these source IDs.

startDatestring

The start date

statusstring[]

A list of event delivery statuses to filter by

subscriptionIdstring

SubscriptionID to filter by

Response

OK

messagestring
statusboolean

Changes

    • warning

      deleted the query request parameter event_type

    • info

      added the new optional query request parameter eventType

    • info

      added the new optional query request parameter idempotencyValue

    • info

      added the new optional query request parameter minTrials

    • info

      added the new optional query request parameter sourceId

    • info

      added the new optional query request parameter query