API documentation

POST /api/v1/inbound_webhooks/ping/:vanity_uri
PING an inbound webhook to retrieve available agents or buyers.

Params

Param name	Description Validations
vanity_uri Optional	The unique identifier for this endpoint. Validations: Must be a String
auth_token Optional	Authorize requests using your token. Get it from your profile: trackdrive.com/profile/edit Validations: Must be a String

POST /api/v1/inbound_webhooks/post/:vanity_uri
POST with a ping_id to retrieve a tracking number for forwarding an inbound call to a matching buyer.

Params

Param name	Description Validations
vanity_uri Optional	The unique identifier for this endpoint. Validations: Must be a String
ping_id Optional	Ping ID Validations: Must be a String

GET /api/v1/inbound_webhooks
List Incoming Webhook records.

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: 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 company_id user_id sortable_order template_description template_enabled template_tier require_caller_id_on_ping vanity_uri offer_id name description webhook_type call_router_ids buyer_ids buyer_group_ids response_body require_traffic_source_id require_user_auth_token company_subdomain tracking_type ring_pool_id include_dynamic_buyers buyer_ping_column_names buyer_post_column_names enable_public_show enable_public_index public_name public_description test_mode buyers_limit_value webhook_read_timeout concurrency_cap_buffer_percent data_append_enabled data_append_group_id Validations: 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: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/inbound_webhooks/new
Build Incoming Webhook with defaults.

Params

Param name	Description Validations
vanity_uri Optional Blank Value Allowed	The unique identifier for this endpoint. Validations: Must be a String
offer_id Optional Blank Value Allowed	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
name Optional Blank Value Allowed	Name Validations: Must be a String
description Optional Blank Value Allowed	Description Validations: Must be a String
webhook_type Optional Blank Value Allowed	Webhook Type Validations: Must be one of: `check_for_available_instant_agent`, `check_for_available_buyer`, `fire_webhooks`.
call_router_ids Optional Blank Value Allowed	Call Router Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
buyer_ids Optional Blank Value Allowed	Buyer Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
buyer_group_ids Optional Blank Value Allowed	Buyer Group Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
response_body Optional Blank Value Allowed	Response Body Validations: Must be a String

POST /api/v1/inbound_webhooks
Create Incoming Webhook.

Params

Param name	Description Validations
vanity_uri Optional Blank Value Allowed	The unique identifier for this endpoint. Validations: Must be a String
offer_id Optional Blank Value Allowed	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
name Optional Blank Value Allowed	Name Validations: Must be a String
description Optional Blank Value Allowed	Description Validations: Must be a String
webhook_type Optional Blank Value Allowed	Webhook Type Validations: Must be one of: `check_for_available_instant_agent`, `check_for_available_buyer`, `fire_webhooks`.
call_router_ids Optional Blank Value Allowed	Call Router Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
buyer_ids Optional Blank Value Allowed	Buyer Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
buyer_group_ids Optional Blank Value Allowed	Buyer Group Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
response_body Optional Blank Value Allowed	Response Body Validations: Must be a String

GET /api/v1/inbound_webhooks/:id
Get Incoming Webhook by id.

PUT /api/v1/inbound_webhooks/:id
Update Incoming Webhook by id.

Params

Param name	Description Validations
vanity_uri Optional Blank Value Allowed	The unique identifier for this endpoint. Validations: Must be a String
offer_id Optional Blank Value Allowed	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
name Optional Blank Value Allowed	Name Validations: Must be a String
description Optional Blank Value Allowed	Description Validations: Must be a String
webhook_type Optional Blank Value Allowed	Webhook Type Validations: Must be one of: `check_for_available_instant_agent`, `check_for_available_buyer`, `fire_webhooks`.
call_router_ids Optional Blank Value Allowed	Call Router Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
buyer_ids Optional Blank Value Allowed	Buyer Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
buyer_group_ids Optional Blank Value Allowed	Buyer Group Ids Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
response_body Optional Blank Value Allowed	Response Body Validations: Must be a String

DELETE /api/v1/inbound_webhooks/:id
Destroy Incoming Webhook by id.