API documentation

GET /webhook_params

Authorization Required

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

List Webhook Param records.

List the custom parameters configured on your outgoing webhook URLs.

Params

Param name	Description
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 company_id user_id key value sortable_order outgoing_webhook_url_id buyer_conversion_id call_control_action_id inbound_webhook_id zoho_crm_command_id 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/webhook_params/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "webhook_params": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "WebhookParam",
      "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": "/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "name": "first_name",
      "company_id": 10001,
      "user_id": 10002,
      "key": "first_name",
      "value": "[first_name]",
      "sortable_order": 1,
      "outgoing_webhook_url_id": null,
      "buyer_conversion_id": null,
      "call_control_action_id": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "inbound_webhook_id": null,
      "zoho_crm_command_id": null,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
      "type": "WebhookParam",
      "uuid": "1d4df925-d435-4b33-a461-efb6c324405e",
      "created_at": "2026-01-15T14:30:00.000Z",
      "updated_at": "2026-01-15T14:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/webhook_params/8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
      "routes_edit_path": "/webhook_params/8a10bcf5-8767-4aa3-a10b-5458e72d5bf9/edit",
      "external_record_id": null,
      "name": "example_param",
      "company_id": 10001,
      "user_id": 10002,
      "key": "example_param",
      "value": "example_value",
      "sortable_order": 1,
      "outgoing_webhook_url_id": null,
      "buyer_conversion_id": null,
      "call_control_action_id": "122f4808-84b2-45c9-a424-db76e14e0eed",
      "inbound_webhook_id": null,
      "zoho_crm_command_id": null,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "webhook_params",
    "page": 1,
    "total_pages": 12,
    "per_page": 2,
    "total_count": 23,
    "next_cursor": 10003
  }
}

GET /webhook_params/new

Authorization Required

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

Build Webhook Param with defaults.

Return a blank webhook parameter populated with default attribute values, useful for building a create form.

Params

Param name	Description
outgoing_webhook_url_id Optional Blank value allowed	Outgoing Webhook Url Must be a valid foreign key reference to an Outgoing Webhook URL. Refer to: /api/docs/1.0/outgoing_webhook_urls
key Optional Blank value allowed	Key Must be a String
value Optional Blank value allowed	Value Must be a String
buyer_conversion_id Optional Blank value allowed	The Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Buyer Conversion. Refer to: /api/docs/1.0/buyer_conversions
call_control_action_id Optional Blank value allowed	The Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Call Control Action. Refer to: /api/docs/1.0/call_control_actions
inbound_webhook_id Optional Blank value allowed	The Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Incoming Webhook. Refer to: /api/docs/1.0/inbound_webhooks
zoho_crm_command_id Optional Blank value allowed	The Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Zoho Crm Command. Refer to: /api/docs/1.0/zoho_crm_commands
token_value_ids Optional Blank value allowed	The Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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"`

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "webhook_param": {
    "id": null,
    "type": "WebhookParam",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/webhook_params/new",
    "routes_edit_path": "/webhook_params/new",
    "external_record_id": null,
    "name": null,
    "company_id": 10001,
    "user_id": null,
    "key": null,
    "value": null,
    "sortable_order": null,
    "outgoing_webhook_url_id": null,
    "buyer_conversion_id": null,
    "call_control_action_id": null,
    "inbound_webhook_id": null,
    "zoho_crm_command_id": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "webhook_param"
  }
}

POST /webhook_params

Authorization Required

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

Create Webhook Param.

Add a custom key/value parameter that will be sent with a specific outgoing webhook URL when it fires. The value can reference token values, which are resolved before the parameter is saved.

Params

Param name	Description
outgoing_webhook_url_id Optional Blank value allowed	Outgoing Webhook Url Must be a valid foreign key reference to an Outgoing Webhook URL. Refer to: /api/docs/1.0/outgoing_webhook_urls
key Optional Blank value allowed	Key Must be a String
value Optional Blank value allowed	Value Must be a String
buyer_conversion_id Optional Blank value allowed	The Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Buyer Conversion. Refer to: /api/docs/1.0/buyer_conversions
call_control_action_id Optional Blank value allowed	The Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Call Control Action. Refer to: /api/docs/1.0/call_control_actions
inbound_webhook_id Optional Blank value allowed	The Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Incoming Webhook. Refer to: /api/docs/1.0/inbound_webhooks
zoho_crm_command_id Optional Blank value allowed	The Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Zoho Crm Command. Refer to: /api/docs/1.0/zoho_crm_commands
token_value_ids Optional Blank value allowed	The Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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"`

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/webhook_params/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "call_control_action_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
  "key": "example_param",
  "value": "[caller_id]"
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "webhook_param": {
    "id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "type": "WebhookParam",
    "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": "/webhook_params/a09e6bca-255b-4217-af73-cb9601c80217",
    "routes_edit_path": "/webhook_params/a09e6bca-255b-4217-af73-cb9601c80217/edit",
    "external_record_id": null,
    "name": "example_param",
    "company_id": 10001,
    "user_id": null,
    "key": "example_param",
    "value": "[caller_id]",
    "sortable_order": 1,
    "outgoing_webhook_url_id": null,
    "buyer_conversion_id": null,
    "call_control_action_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "inbound_webhook_id": null,
    "zoho_crm_command_id": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "webhook_param"
  }
}

GET /webhook_params/:id

Authorization Required

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

Get Webhook Param by id.

Get the details of a single webhook parameter by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "webhook_param": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "WebhookParam",
    "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": "/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "first_name",
    "company_id": 10001,
    "user_id": 10002,
    "key": "first_name",
    "value": "[first_name]",
    "sortable_order": 1,
    "outgoing_webhook_url_id": null,
    "buyer_conversion_id": null,
    "call_control_action_id": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
    "inbound_webhook_id": null,
    "zoho_crm_command_id": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "webhook_param"
  }
}

PUT /webhook_params/:id

Authorization Required

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

Update Webhook Param by id.

Update the key, value, or owning webhook URL of an existing webhook parameter.

Params

Param name	Description
outgoing_webhook_url_id Optional Blank value allowed	Outgoing Webhook Url Must be a valid foreign key reference to an Outgoing Webhook URL. Refer to: /api/docs/1.0/outgoing_webhook_urls
key Optional Blank value allowed	Key Must be a String
value Optional Blank value allowed	Value Must be a String
buyer_conversion_id Optional Blank value allowed	The Buyer Conversion webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Buyer Conversion. Refer to: /api/docs/1.0/buyer_conversions
call_control_action_id Optional Blank value allowed	The Call Control Action webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Call Control Action. Refer to: /api/docs/1.0/call_control_actions
inbound_webhook_id Optional Blank value allowed	The Inbound Webhook this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Incoming Webhook. Refer to: /api/docs/1.0/inbound_webhooks
zoho_crm_command_id Optional Blank value allowed	The Zoho Action this param belongs to, if it is not attached to an Outgoing Webhook URL. Must be a valid foreign key reference to an Zoho Crm Command. Refer to: /api/docs/1.0/zoho_crm_commands
token_value_ids Optional Blank value allowed	The Tokens whose data replaces this Webhook Param’s value tokens when the webhook fires. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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"`

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": "[caller_id_formatted]"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "webhook_param": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "WebhookParam",
    "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": "/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "example_param",
    "company_id": 10001,
    "user_id": null,
    "key": "example_param",
    "value": "[caller_id_formatted]",
    "sortable_order": 2,
    "outgoing_webhook_url_id": null,
    "buyer_conversion_id": null,
    "call_control_action_id": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
    "inbound_webhook_id": null,
    "zoho_crm_command_id": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "webhook_param"
  }
}

DELETE /webhook_params/:id

Authorization Required

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

Destroy Webhook Param by id.

Permanently remove a webhook parameter so it is no longer sent with its webhook.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "webhook_param": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "WebhookParam",
    "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
    "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": "/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/webhook_params/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "example_param",
    "company_id": 10001,
    "user_id": null,
    "key": "example_param",
    "value": "[caller_id]",
    "sortable_order": 2,
    "outgoing_webhook_url_id": null,
    "buyer_conversion_id": null,
    "call_control_action_id": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
    "inbound_webhook_id": null,
    "zoho_crm_command_id": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "webhook_param"
  }
}

Params

Must be any combination of:

Params

Params

Params