Create a new outgoing webhook setting.

post

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

On success returns 201 with the new setting id in the response data and a Location
header. conversionTypeIds selects which conversion types fire the webhook (null = all types).
Requires an account-admin token and an affiliate-scoped token (enforced by RequiredAffiliate).

🔐 Required permission: AccountAdmin

🔐 Requires an Affiliate context (AffiliateId in header or token)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The webhook setting to create.

Request body to create an outgoing webhook setting.

name

string | null

Required. Display name of the webhook.

url

string | null

Required. Destination URL the webhook is delivered to.

source

string | null

Optional source/label associated with the webhook.

trafficSourceId

int32 | null

Optional traffic source id to scope the webhook to; null = affiliate-level.

httpMethod

string | null

The HTTP method to use when send the event

conversionTypeIds

array of int32s | null

a conversions type ids that will trigger the webhook. if null, all conversions will trigger the webhook

conversionTypeIds

conversionTypes

object | null

Optional per-conversion-type name overrides keyed by conversion type id. Bound from the JSON property conversionTypes.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

`data` holds its id.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

201The webhook setting was created; data holds its id.

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error

`data` holds its id.