Skip to main content
GET
ListDeliveries

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

integrationId
string

Restrict to one integration. Omit for the whole workspace's feed.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
eventId
string

Restrict to one event — every integration it reached, and what each did with it. This is the event_id from a received webhook payload.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
subjectId
string

Restrict to the issue or incident the delivery was about. Takes the same identifier the rest of the API uses for that object.

Maximum string length: 200
eventTypes
string[]

Restrict to these event types, by synq.webhooks.v1.Event.EventType name. Empty matches every type.

Maximum array length: 20
Maximum string length: 100
outcomes
enum<string>[]

Restrict to these outcomes. Empty matches every outcome.

Maximum array length: 5

Outcome is what became of a delivery. It is a state the service maintains, not something to recompute from status codes: a 500 that will be retried and a 500 that exhausted the retries are the same status and different outcomes.

Available options:
OUTCOME_UNSPECIFIED,
OUTCOME_PENDING,
OUTCOME_DELIVERED,
OUTCOME_FAILED,
OUTCOME_SKIPPED,
OUTCOME_NOT_ROUTED
statusCodes
integer<int32>[]

Restrict to deliveries whose most recent attempt returned one of these HTTP statuses. Empty matches every status.

Maximum array length: 20
Required range: 100 <= x <= 599
since.seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

since.nanos
integer<int32>

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

pagination.cursor
string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize
integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0
includeRouting
boolean

Also return matched_alert_configs and correlation_key on each delivery. Off by default: it costs a second read per delivery, and a feed rarely needs it. BatchGetDeliveries always returns them.

Response

200 - application/json

Success

deliveries
Delivery · object[]

The matching deliveries, newest event first.

pageInfo
PageInfo · object

Cursor for the next page.