Response Example

{
  "status" : 200,
  "outgoing_webhooks" : [
    {
      "id" : 1590,
      "created_at" : "2019-08-11T14:37:37.413+00:00",
      "updated_at" : "2019-08-11T14:37:37.413+00:00",
      "user_updated_at" : null,
      "name" : "Schedule Webhook",
      "trigger_type" : null,
      "trigger_duration" : null,
      "company_id" : 34313,
      "offer_id" : null,
      "schedule_action_id" : null,
      "type" : "Webhook::Outgoing",
      "sortable_order" : -1,
      "token_value_ids" : null,
      "outgoing_url_ids" : [],
      "token_value_map_ids" : []
    },
    {
      "id" : 1589,
      "created_at" : "2019-08-11T14:37:22.990+00:00",
      "updated_at" : "2019-08-11T14:37:22.990+00:00",
      "user_updated_at" : null,
      "name" : "Schedule Webhook",
      "trigger_type" : null,
      "trigger_duration" : null,
      "company_id" : 34313,
      "offer_id" : null,
      "schedule_action_id" : null,
      "type" : "Webhook::Outgoing",
      "sortable_order" : -1,
      "token_value_ids" : null,
      "outgoing_url_ids" : [],
      "token_value_map_ids" : []
    }
  ],
  "metadata" : {
    "root" : "outgoing_webhooks",
    "page" : 1,
    "total_pages" : 6,
    "per_page" : 2,
    "total_count" : 12,
    "next_cursor" : 1589
  }
}

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
optional

Filter for webhooks that are assigned to this offer.

schedule_action_id
optional

Filter for webhooks that are assigned to this Schedule Action.

trigger_type
optional

When does this trigger fire?

  • Must be one of: every_call, buyer_dialled, buyer_answered, timer, either_converted, buyer_converted, buyer_did_not_convert, only_buyer_converted, offer_converted, offer_did_not_convert, only_offer_converted, both_converted, did_not_convert.

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 String

created_at_from
optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

fulltext
optional

Search for any record that matches this text

  • Must be String

time_zone
optional

Date ranges will be parsed using this time zone.

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
  • created_at
  • updated_at
  • user_updated_at
  • name
  • trigger_type
  • trigger_duration
  • company_id
  • offer_id
  • schedule_action_id
  • type
  • sortable_order
  • token_value_ids
  • outgoing_url_ids
  • token_value_map_ids
  • Must be 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