API Reference

Update an existing outgoing webhook setting by id.

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

Replaces the setting's configuration including its status (Enabled, Disabled, Suspended) and
the conversion types that trigger it. Requires an account-admin token.

🔐 Required permission: AccountAdmin

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The numeric identifier of the webhook setting to update.

Body Params

The updated webhook setting values.

Request body to update an outgoing webhook setting.

string | null

Required. Display name of the webhook.

string | null

Required. Destination URL the webhook is delivered to.

string | null

Optional source/label associated with the webhook.

int32 | null

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

string
enum

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

Allowed:
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:
string
enum
Defaults to application/json

Generated from available request 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