Events

This endpoint fetches app events with pagination

get/v1/projects/{projectID}/events

Request

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

Path parameters

projectIDstring required

Project ID

Query parameters

bodystring

URL-encoded JSON object matched against the event payload. Combined with query as AND when both are set.

direction'next' | 'prev'
endDatestring

The end date

endpointIdstring[]

A list of endpoint ids 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. List only; pass sourceId if several sources qualify. Not combinable with idempotencyKey.

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 event id prefix, idempotency key, event type, and source name. A JSON object uses payload containment, same as body. Text plus JSON ANDs both.

queryModestring

Set to text to search metadata literally, without interpreting JSON in query.

sortstring

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

sourceIdstring[]

A list of Source IDs to filter the events by.

startDatestring

The start date

Response

OK

messagestring
statusboolean

Changes