POST /outgoing_webhook_urls

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/outgoing_webhook_urls

Create a webhook url

Attach a remote URL, HTTP method, and POST body and headers to an existing Outgoing Webhook, so that URL is called whenever the webhook's trigger fires.

Params

Param name Description
outgoing_webhook_id
Required

Assign the record to this Outgoing Webhook.
remote_url
Optional

Remote URL

  • Must be a String
remote_method
Optional

Remote Method

  • Must be one of: get, post, post_body, post_api_v1, put, delete, patch.
post_body
Optional

POST Body. Custom POST Body can be used to send JSON or XML requests. Example JSON Body: {"revenue":10, "caller_id": "1231231234"}

  • Must be a String
post_headers
Optional

POST Headers. Set the HTTP headers. List each header on a separate line. Example Headers: Content-Type: application/json

  • Must be a String
sortable_order
Optional Blank value allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

  • Must be a decimal number.
name
Optional Blank value allowed

A friendly name for this webhook URL, shown when managing the webhook.

  • Must be a String
webhook_read_timeout
Optional Blank value allowed

The number of seconds to wait for the remote server’s response before treating the request as failed. Must be between 3 and 29.

  • Must be a decimal number.
extract_webhook_params
Optional Blank value allowed

When true, on save Trackdrive removes query string parameters from the Remote URL and creates a matching Webhook Param for each one.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyer_ping_parser_ids
Optional Blank value allowed

The Ping Parsers applied to this URL’s response, used when its webhook fires before dialing a buyer.
token_value_map_group_ids
Optional Blank value allowed

Map lead and call data to custom values by assigning these Token Value Map Groups to this URL.
filter_token_value_ids
Optional Blank value allowed

The Tokens used with record_token_filter_list to decide whether this URL’s webhook fires for a call.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
record_token_filter_list
Optional Blank value allowed

Assign filters to the object by passing an array of key:value pairs

  • Must be a valid list of filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
webhook_response_success_codes
Optional Blank value allowed

A comma-separated list of HTTP status codes treated as a successful response, for example 200,201.

  • Must be a String
webhook_body_success_path
Optional Blank value allowed

The path within the response body checked to confirm the request succeeded, for example result.status.

  • Must be a String
webhook_body_success_match
Optional Blank value allowed

The value the response body’s webhook_body_success_path must match for the request to be treated as successful.

  • Must be a String
cache_success_for_seconds
Optional Blank value allowed

The number of seconds a successful response is cached and reused for a repeat request instead of contacting the remote server again.

  • Must be a decimal number.
suppression_on_failure
Optional Blank value allowed

When true, a caller is added to a suppression list after enough consecutive failures from this URL.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
suppression_failure_threshold
Optional Blank value allowed

The number of consecutive failures from this URL before the caller is added to the suppression list.

  • Must be a decimal number.
suppression_buyer_suppression_id
Optional Blank value allowed

The suppression list callers are added to once suppression_failure_threshold consecutive failures occur.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
retry_on_failure
Optional Blank value allowed

When true, a failed request to this URL is retried.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
retry_max_attempts
Optional Blank value allowed

The maximum number of times a failed request to this URL is retried. Must be between 0 and 10.

  • Must be a decimal number.
retry_delay_seconds
Optional Blank value allowed

The number of seconds to wait before retrying a failed request to this URL. Must be between 30 and 3600.

  • Must be a decimal number.