API documentation

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"
  }
}