API Reference

List outgoing webhook events matching the supplied filter.

get
https://platform.routy.app/api/v1/conversions/outgoing/webhooks/events

Requires an account-admin token. Paginate with offset (0-based) and limit. Filter by
ids, affiliate/account/brand/traffic-source ids, webhook setting id, click/conversion ids, conversion
type ids, date ranges (from/to, fromCreatedAt) and status
(New, Success, Failed, RetryQueued, OutOfQuota, Cancelled). Set includeConversion=true to embed
the related conversion.

🔐 Required permission: AccountAdmin

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
Id
array of int64s

Optional list of webhook event ids.

Id
AffiliateId
array of int32s

Optional list of affiliate ids to filter by.

AffiliateId
AccountId
array of int32s

Optional list of account ids to filter by.

AccountId
TrafficSourceId
array of int32s

Optional list of traffic source ids to filter by.

TrafficSourceId
BrandId
array of int32s

Optional list of brand ids to filter by.

BrandId
int32

Optional id of the webhook setting that produced the events.

ClickId
array of uuids

Optional list of originating click ids.

ClickId
ConversionTypeId
array of int32s

Optional list of conversion type ids.

ConversionTypeId
ConversionId
array of int64s

Optional list of conversion ids.

ConversionId
date-time

Filter events from this date (inclusive).

date-time

Filter events up to this date (inclusive).

Status
array of objects

Filter by status: New (0), Success (1), Failed (2), RetryQueued (3), OutOfQuota (4) or Cancelled (6).

Status
Allowed:
int32

Optional filter for events whose attempt count is at most this value.

date-time

Optional filter on the last delivery attempt timestamp.

int32

Maximum number of records to return. Optional.

int32

Number of records to skip (0-based offset). Optional.

string

Optional free-text search term.

string

Optional sort expression (column name, optionally prefixed with - for descending).

date-time

Filter by the starting date of the creation time range.

boolean

When true, embeds the related conversion in each returned event.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago