API documentation

GET /inbound_webhooks/new

Authorization Required

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

Build Incoming Webhook with defaults.

Returns a blank Incoming Webhook populated with default attribute values, without saving it, so you can see the defaults before building a create request.

Params

Param name	Description
vanity_uri Optional Blank value allowed	The unique identifier for this endpoint. Must be a String
offer_id Optional Blank value allowed	Offer Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
webhook_type Optional Blank value allowed	Webhook Type 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 Must be an array of decimal values. EG: `[0, 1, 2, 3]`
buyer_ids Optional Blank value allowed	Buyer Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
buyer_group_ids Optional Blank value allowed	Buyer Group Ids Must be an array of decimal values. EG: `[0, 1, 2, 3]`
response_body Optional Blank value allowed	Response Body Must be a String
require_traffic_source_id Optional Blank value allowed	Require a traffic_source_id on every ping and post to this endpoint. Must be a boolean value: 1, true, yes, on, 0, false, no, off
require_caller_id_on_ping Optional Blank value allowed	Require a caller_id on every ping to this endpoint. Must be a boolean value: 1, true, yes, on, 0, false, no, off
require_user_auth_token Optional Blank value allowed	Require a valid developer access token on every ping and post to this endpoint. Must be a boolean value: 1, true, yes, on, 0, false, no, off
tracking_type Optional Blank value allowed	How a forwarding number is provided when a buyer is available, such as a number from a Number Pool or the caller’s own number. Must be a String
ring_pool_id Optional Blank value allowed	The Number Pool a tracking number is assigned from when tracking_type uses a Number Pool. Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
test_mode Optional Blank value allowed	When enabled, calls and leads sent to this endpoint are processed without being delivered to buyers, so it can be tested safely. Must be a boolean value: 1, true, yes, on, 0, false, no, off
include_dynamic_buyers Optional Blank value allowed	Also search buyers that were dynamically assigned to the offer, not only the buyers and buyer groups selected here. Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyers_limit_value Optional Blank value allowed	The maximum number of available buyers to return on a ping. Must be a decimal number.
webhook_read_timeout Optional Blank value allowed	How many seconds to wait for a response before timing out the request. Must be a decimal number.
concurrency_cap_buffer_percent Optional Blank value allowed	Percentage buffer applied to buyer concurrency caps when checking for available buyers. Must be a decimal number.
rate_limit_per_minute Optional Blank value allowed	Maximum number of requests this endpoint will accept per minute, across all traffic sources. Must be a decimal number.
rate_limit_per_hour Optional Blank value allowed	Maximum number of requests this endpoint will accept per hour, across all traffic sources. Must be a decimal number.
rate_limit_per_day Optional Blank value allowed	Maximum number of requests this endpoint will accept per day, across all traffic sources. Must be a decimal number.
rate_limit_per_minute_per_traffic_source Optional Blank value allowed	Maximum number of requests this endpoint will accept per minute, per traffic source. Must be a decimal number.
rate_limit_per_hour_per_traffic_source Optional Blank value allowed	Maximum number of requests this endpoint will accept per hour, per traffic source. Must be a decimal number.
rate_limit_per_day_per_traffic_source Optional Blank value allowed	Maximum number of requests this endpoint will accept per day, per traffic source. Must be a decimal number.
traffic_source_rate_limiter_id Optional Blank value allowed	A Traffic Source Rate Limiter used to apply shared rate limits across multiple traffic sources. 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
buyer_ping_column_names Optional Blank value allowed	The response fields to include for each buyer when responding to a ping. Must be an array of strings. EG: `["abc123", "xzy023"]`
buyer_post_column_names Optional Blank value allowed	The response fields to include when responding to a post. Must be an array of strings. EG: `["abc123", "xzy023"]`
enable_public_show Optional Blank value allowed	Make this endpoint’s posting instructions viewable on a public, unauthenticated page. Must be a boolean value: 1, true, yes, on, 0, false, no, off
enable_public_index Optional Blank value allowed	List this endpoint on the public index page of your account’s published posting instructions. Must be a boolean value: 1, true, yes, on, 0, false, no, off
public_name Optional Blank value allowed	The name shown for this endpoint on its public posting instructions page. Must be a String
public_description Optional Blank value allowed	The description shown for this endpoint on its public posting instructions page. Must be a String

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "inbound_webhook": {
    "id": null,
    "type": "InboundWebhook",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/inbound_webhooks/new",
    "routes_edit_path": "/inbound_webhooks/new",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "sortable_order": null,
    "require_caller_id_on_ping": true,
    "vanity_uri": null,
    "offer_id": null,
    "name": null,
    "description": null,
    "webhook_type": "check_for_available_buyer",
    "call_router_ids": null,
    "buyer_ids": null,
    "buyer_group_ids": null,
    "response_body": null,
    "require_traffic_source_id": true,
    "require_user_auth_token": null,
    "company_subdomain": "publisher",
    "tracking_type": "caller_number",
    "ring_pool_id": null,
    "include_dynamic_buyers": true,
    "buyer_ping_column_names": [
      "id",
      "offer_conversion_payout",
      "concurrency_cap_limit"
    ],
    "buyer_post_column_names": [
      "id",
      "offer_conversion_payout",
      "concurrency_cap_limit"
    ],
    "enable_public_show": true,
    "enable_public_index": null,
    "public_name": null,
    "public_description": null,
    "public_instructions_enabled": true,
    "test_mode": null,
    "buyers_limit_value": 5,
    "webhook_read_timeout": null,
    "concurrency_cap_buffer_percent": null,
    "rate_limit_per_minute": null,
    "rate_limit_per_hour": null,
    "rate_limit_per_day": null,
    "rate_limit_per_minute_per_traffic_source": null,
    "rate_limit_per_hour_per_traffic_source": null,
    "rate_limit_per_day_per_traffic_source": null,
    "traffic_source_rate_limiter_id": null,
    "data_append_type": null
  },
  "metadata": {
    "root": "inbound_webhook"
  }
}