API documentation

GET /outgoing_webhook_urls

Authorization Required

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

List webhook urls

List the remote URLs configured under your Outgoing Webhooks, optionally filtered by outgoing_webhook_id.

Params

Param name	Description
outgoing_webhook_id Optional	Filter for urls that are assigned to this webhook. Must be a valid foreign key reference to an Trigger. Refer to: /api/docs/1.0/outgoing_webhooks
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id name outgoing_webhook_id offer_id remote_url remote_method sortable_order post_body post_headers response_parser_ids webhook_params_count webhook_read_timeout buyer_ping_parser_ids outgoing_webhook_trigger_type has_response_acceptance token_value_map_group_ids webhook_response_success_codes webhook_body_success_path webhook_body_success_match webhook_body_success_operator cache_success_for_seconds suppression_on_failure suppression_failure_threshold suppression_buyer_suppression_id retry_on_failure retry_max_attempts retry_delay_seconds record_token_filter_id record_token_filter_data_count record_token_filter_data Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/outgoing_webhook_urls/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "outgoing_urls": [
    {
      "id": 10001,
      "type": "Webhook::OutgoingUrl",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": null,
      "external_record_id": null,
      "name": "Secondary Delivery",
      "outgoing_webhook_id": 10002,
      "offer_id": 10003,
      "remote_url": "https://crm.example.com/webhooks/secondary",
      "remote_method": "get",
      "sortable_order": -2,
      "post_body": null,
      "post_headers": null,
      "response_parser_ids": [],
      "webhook_params_count": 0,
      "webhook_read_timeout": 15,
      "buyer_ping_parser_ids": null,
      "outgoing_webhook_trigger_type": "offer_converted",
      "has_response_acceptance": false,
      "token_value_map_group_ids": null,
      "webhook_response_success_codes": null,
      "webhook_body_success_path": null,
      "webhook_body_success_match": null,
      "webhook_body_success_operator": null,
      "cache_success_for_seconds": null,
      "suppression_on_failure": false,
      "suppression_failure_threshold": 3,
      "suppression_buyer_suppression_id": null,
      "retry_on_failure": false,
      "retry_max_attempts": 3,
      "retry_delay_seconds": 180,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": 10004,
      "type": "Webhook::OutgoingUrl",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": null,
      "external_record_id": null,
      "name": "Primary Delivery",
      "outgoing_webhook_id": 10002,
      "offer_id": 10003,
      "remote_url": "https://crm.example.com/webhooks/primary",
      "remote_method": "post",
      "sortable_order": -1,
      "post_body": null,
      "post_headers": null,
      "response_parser_ids": [
        10005,
        10006
      ],
      "webhook_params_count": 0,
      "webhook_read_timeout": 15,
      "buyer_ping_parser_ids": null,
      "outgoing_webhook_trigger_type": "offer_converted",
      "has_response_acceptance": false,
      "token_value_map_group_ids": null,
      "webhook_response_success_codes": null,
      "webhook_body_success_path": null,
      "webhook_body_success_match": null,
      "webhook_body_success_operator": null,
      "cache_success_for_seconds": null,
      "suppression_on_failure": false,
      "suppression_failure_threshold": 3,
      "suppression_buyer_suppression_id": null,
      "retry_on_failure": false,
      "retry_max_attempts": 3,
      "retry_delay_seconds": 180,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "outgoing_urls",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 2,
    "next_cursor": 10007
  }
}

GET /outgoing_webhook_urls/new

Authorization Required

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

Build a new webhook url

Return a new, unsaved outgoing webhook URL pre-filled with defaults. Requires an outgoing_webhook_id.

Params

Param name	Description
outgoing_webhook_id Required	Assign the record to this Outgoing Webhook. Must be a valid foreign key reference to an Trigger. Refer to: /api/docs/1.0/outgoing_webhooks
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. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Ping Parser. Refer to: /api/docs/1.0/buyer_ping_parsers
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. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Filter Mapping Group. Refer to: /api/docs/1.0/token_value_map_groups
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.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/outgoing_webhook_urls/new?outgoing_webhook_id=10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "outgoing_url": {
    "id": null,
    "type": "Webhook::OutgoingUrl",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "name": null,
    "outgoing_webhook_id": 10001,
    "offer_id": null,
    "remote_url": null,
    "remote_method": null,
    "sortable_order": null,
    "post_body": null,
    "post_headers": null,
    "response_parser_ids": [],
    "webhook_params_count": 0,
    "webhook_read_timeout": 15,
    "buyer_ping_parser_ids": null,
    "outgoing_webhook_trigger_type": "new_call_started",
    "has_response_acceptance": false,
    "token_value_map_group_ids": null,
    "webhook_response_success_codes": null,
    "webhook_body_success_path": null,
    "webhook_body_success_match": null,
    "webhook_body_success_operator": null,
    "cache_success_for_seconds": null,
    "suppression_on_failure": false,
    "suppression_failure_threshold": 3,
    "suppression_buyer_suppression_id": null,
    "retry_on_failure": false,
    "retry_max_attempts": 3,
    "retry_delay_seconds": 180,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "outgoing_url"
  }
}

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. Must be a valid foreign key reference to an Trigger. Refer to: /api/docs/1.0/outgoing_webhooks
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. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Ping Parser. Refer to: /api/docs/1.0/buyer_ping_parsers
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. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Filter Mapping Group. Refer to: /api/docs/1.0/token_value_map_groups
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.

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/outgoing_webhook_urls/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "outgoing_webhook_id": 10001,
  "name": "Example Webhook URL",
  "remote_url": "https://example.com/webhooks/trackdrive",
  "remote_method": "post",
  "post_body": "{\"source\": \"trackdrive\"}",
  "post_headers": "Content-Type: application/json"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "outgoing_url": {
    "id": 10002,
    "type": "Webhook::OutgoingUrl",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "name": "Example Webhook URL",
    "outgoing_webhook_id": 10001,
    "offer_id": null,
    "remote_url": "https://example.com/webhooks/trackdrive",
    "remote_method": "post",
    "sortable_order": -1,
    "post_body": "{\"source\": \"trackdrive\"}",
    "post_headers": "Content-Type: application/json",
    "response_parser_ids": [],
    "webhook_params_count": 0,
    "webhook_read_timeout": 15,
    "buyer_ping_parser_ids": null,
    "outgoing_webhook_trigger_type": "new_call_started",
    "has_response_acceptance": false,
    "token_value_map_group_ids": null,
    "webhook_response_success_codes": null,
    "webhook_body_success_path": null,
    "webhook_body_success_match": null,
    "webhook_body_success_operator": null,
    "cache_success_for_seconds": null,
    "suppression_on_failure": false,
    "suppression_failure_threshold": 3,
    "suppression_buyer_suppression_id": null,
    "retry_on_failure": false,
    "retry_max_attempts": 3,
    "retry_delay_seconds": 180,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "outgoing_url"
  }
}

GET /outgoing_webhook_urls/:id

Authorization Required

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

Show the details of a webhook url

Retrieve the configuration of a single outgoing webhook URL.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/outgoing_webhook_urls/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "outgoing_url": {
    "id": 10002,
    "type": "Webhook::OutgoingUrl",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "name": "Secondary Delivery",
    "outgoing_webhook_id": 10003,
    "offer_id": 10004,
    "remote_url": "https://crm.example.com/webhooks/secondary",
    "remote_method": "get",
    "sortable_order": -2,
    "post_body": null,
    "post_headers": null,
    "response_parser_ids": [],
    "webhook_params_count": 0,
    "webhook_read_timeout": 15,
    "buyer_ping_parser_ids": null,
    "outgoing_webhook_trigger_type": "offer_converted",
    "has_response_acceptance": false,
    "token_value_map_group_ids": null,
    "webhook_response_success_codes": null,
    "webhook_body_success_path": null,
    "webhook_body_success_match": null,
    "webhook_body_success_operator": null,
    "cache_success_for_seconds": null,
    "suppression_on_failure": false,
    "suppression_failure_threshold": 3,
    "suppression_buyer_suppression_id": null,
    "retry_on_failure": false,
    "retry_max_attempts": 3,
    "retry_delay_seconds": 180,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "outgoing_url"
  }
}

PUT /outgoing_webhook_urls/:id

Authorization Required

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

Update a webhook url

Change the remote URL, HTTP method, POST body, headers, or sort order of an existing outgoing webhook URL.

Params

Param name	Description
outgoing_webhook_id Optional	Assign the record to this Outgoing Webhook. Must be a valid foreign key reference to an Trigger. Refer to: /api/docs/1.0/outgoing_webhooks
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. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Ping Parser. Refer to: /api/docs/1.0/buyer_ping_parsers
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. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Filter Mapping Group. Refer to: /api/docs/1.0/token_value_map_groups
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.

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/outgoing_webhook_urls/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Webhook URL (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "outgoing_url": {
    "id": 10002,
    "type": "Webhook::OutgoingUrl",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "name": "Example Webhook URL (renamed)",
    "outgoing_webhook_id": 10003,
    "offer_id": null,
    "remote_url": "https://example.com/webhooks/trackdrive",
    "remote_method": "post",
    "sortable_order": -2,
    "post_body": "{\"source\": \"trackdrive\"}",
    "post_headers": "Content-Type: application/json",
    "response_parser_ids": [],
    "webhook_params_count": 0,
    "webhook_read_timeout": 15,
    "buyer_ping_parser_ids": null,
    "outgoing_webhook_trigger_type": "new_call_started",
    "has_response_acceptance": false,
    "token_value_map_group_ids": null,
    "webhook_response_success_codes": null,
    "webhook_body_success_path": null,
    "webhook_body_success_match": null,
    "webhook_body_success_operator": null,
    "cache_success_for_seconds": null,
    "suppression_on_failure": false,
    "suppression_failure_threshold": 3,
    "suppression_buyer_suppression_id": null,
    "retry_on_failure": false,
    "retry_max_attempts": 3,
    "retry_delay_seconds": 180,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "outgoing_url"
  }
}

DELETE /outgoing_webhook_urls/:id

Authorization Required

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

Delete a webhook url

Permanently remove a URL from an Outgoing Webhook. It will stop being called when the webhook's trigger fires.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/outgoing_webhook_urls/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "outgoing_url": {
    "id": 10002,
    "type": "Webhook::OutgoingUrl",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "name": "Example Webhook URL",
    "outgoing_webhook_id": 10003,
    "offer_id": null,
    "remote_url": "https://example.com/webhooks/trackdrive",
    "remote_method": "post",
    "sortable_order": -2,
    "post_body": "{\"source\": \"trackdrive\"}",
    "post_headers": "Content-Type: application/json",
    "response_parser_ids": [],
    "webhook_params_count": 0,
    "webhook_read_timeout": 15,
    "buyer_ping_parser_ids": null,
    "outgoing_webhook_trigger_type": "new_call_started",
    "has_response_acceptance": false,
    "token_value_map_group_ids": null,
    "webhook_response_success_codes": null,
    "webhook_body_success_path": null,
    "webhook_body_success_match": null,
    "webhook_body_success_operator": null,
    "cache_success_for_seconds": null,
    "suppression_on_failure": false,
    "suppression_failure_threshold": 3,
    "suppression_buyer_suppression_id": null,
    "retry_on_failure": false,
    "retry_max_attempts": 3,
    "retry_delay_seconds": 180,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "outgoing_url"
  }
}

Params

Must be any combination of:

Params

Params

Params