API Reference

List outgoing webhook settings matching the supplied filter.

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

Requires an account-admin token. Paginate with offset (0-based) and limit. Filter by
affiliate/account/brand/traffic-source ids, conversion type ids, status
(Enabled, Disabled, Suspended) and includeAffiliateLevelOnly (settings with no traffic source).

🔐 Required permission: AccountAdmin

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

Optional list of affiliate ids to filter by.

AffiliateId
TrafficSourceId
array of int32s

Optional list of traffic source ids to filter by.

TrafficSourceId
AccountId
array of int32s

Optional list of account ids to filter by.

AccountId
BrandId
array of int32s

Optional list of brand ids to filter by.

BrandId
string
enum

Filter by status: Enabled (0), Disabled (1) or Suspended (2).

Allowed:
int32

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

int32

Maximum number of records to return. Optional.

ConversionTypeId
array of int32s

Optional list of conversion type ids the webhook is configured for.

ConversionTypeId
string

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

boolean

When true, only returns webhook settings without a traffic source (affiliate-level webhooks)

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