API documentation

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_values Optional Blank value allowed	Only sends this param for requests matching these filters, such as [“state:CA”, “age:>=21”]. Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`
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"
  }
}