API documentation

GET /subscriptions

Authorization Required

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

List Subscriptions

List all webhook event subscriptions on your account. Supports pagination with the page parameter.

Params

Param name	Description
page Optional	Return the next page of results. Must be a number.

Param name

Description

page
Optional

Return the next page of results.

Must be a number.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/subscriptions/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "subscriptions": [
    {
      "id": 10001,
      "type": "WebhookSubscription",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "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_subscriptions/10002",
      "routes_edit_path": "/webhook_subscriptions/10002/edit",
      "external_record_id": null,
      "company_id": 10003,
      "user_id": 10004,
      "target_url": "https://crm.example.com/webhooks/new-call",
      "event": "new_call",
      "trigger_fields": {
        "schedule_id": null,
        "traffic_source_id": null,
        "offer_id": null,
        "buyer_converted": null,
        "has_recording": null,
        "either_converted": null,
        "buyer_id": null,
        "offer_converted": null,
        "number_id": null,
        "token_list": null
      }
    },
    {
      "id": 10005,
      "type": "WebhookSubscription",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "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_subscriptions/10006",
      "routes_edit_path": "/webhook_subscriptions/10006/edit",
      "external_record_id": null,
      "company_id": 10003,
      "user_id": 10004,
      "target_url": "https://crm.example.com/webhooks/call-ended",
      "event": "call_ended",
      "trigger_fields": {
        "schedule_id": null,
        "traffic_source_id": null,
        "offer_id": null,
        "buyer_converted": null,
        "has_recording": null,
        "either_converted": null,
        "buyer_id": null,
        "offer_converted": null,
        "number_id": null,
        "token_list": null
      }
    },
    {
      "id": 10007,
      "type": "WebhookSubscription",
      "uuid": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "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_subscriptions/10008",
      "routes_edit_path": "/webhook_subscriptions/10008/edit",
      "external_record_id": null,
      "company_id": 10003,
      "user_id": 10004,
      "target_url": "https://crm.example.com/webhooks/call-forwarded",
      "event": "call_forwarded",
      "trigger_fields": {
        "schedule_id": null,
        "traffic_source_id": null,
        "offer_id": null,
        "buyer_converted": null,
        "has_recording": null,
        "either_converted": null,
        "buyer_id": null,
        "offer_converted": null,
        "number_id": null,
        "token_list": null
      }
    }
  ],
  "metadata": {
    "root": "subscriptions",
    "page": 1,
    "total_pages": 0,
    "per_page": 25,
    "total_count": 10,
    "next_cursor": 10024
  }
}

GET /subscriptions/new

Authorization Required

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

Build Webhook Subscription with defaults.

Return a new, unsaved subscription pre-filled with your company defaults, useful for previewing the record shape before creating one.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "subscription": {
    "id": null,
    "type": "WebhookSubscription",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/webhook_subscriptions/new",
    "routes_edit_path": "/webhook_subscriptions/new",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "target_url": null,
    "event": null,
    "trigger_fields": {
      "schedule_id": null,
      "traffic_source_id": null,
      "offer_id": null,
      "buyer_converted": null,
      "has_recording": null,
      "either_converted": null,
      "buyer_id": null,
      "offer_converted": null,
      "number_id": null,
      "token_list": null
    }
  },
  "metadata": {
    "root": "subscription"
  }
}

POST /subscriptions

Authorization Required

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

Create a subscription

Subscribe a target_url to a Trackdrive event such as new_call. Trackdrive POSTs the event payload to that URL every time the event fires. If a subscription already exists for the same target_url and event it is updated instead of duplicated. Optional trigger_fields limit delivery to records matching specific field values.

Params

Param name Description

Param name	Description
target_url Required	The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered. Must be a valid URL.
event Required	The event that will be triggered. EG: When a new call comes in. Must be one of: `new_call`, `call_ringing`, `call_forwarded`, `call_ended`, `call_changed`, `new_lead`, `lead_ended`, `lead_converted`, `lead_opted_out`, `lead_changed`, `incoming_text_message`.
trigger_fields Optional	Filter the data returned by the subscription. Only trigger if the object matches the given trigger fields. For example: `{buyer_converted: true, offer_id: 1}` would only fire the trigger if the call converted and came from offer 1. Acceptable triggers: `schedule_id` `traffic_source_id` `offer_id` `buyer_converted` `has_recording` `either_converted` `buyer_id` `offer_converted` `number_id` Must be a Hash

target_url
Required

The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.

Must be a valid URL.

event
Required

The event that will be triggered. EG: When a new call comes in.

Must be one of: new_call, call_ringing, call_forwarded, call_ended, call_changed, new_lead, lead_ended, lead_converted, lead_opted_out, lead_changed, incoming_text_message.

trigger_fields
Optional

Filter the data returned by the subscription. Only trigger if the object matches the given trigger fields. For example:
{buyer_converted: true, offer_id: 1} would only fire the trigger if the call converted and came from offer 1. Acceptable triggers: schedule_id traffic_source_id offer_id buyer_converted has_recording either_converted buyer_id offer_converted number_id

Must be a Hash

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/subscriptions/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "target_url": "https://hooks.example.com/trackdrive",
  "event": "new_call",
  "trigger_fields": {
    "offer_converted": true
  }
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "subscription": {
    "id": 10001,
    "type": "WebhookSubscription",
    "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_subscriptions/10002",
    "routes_edit_path": "/webhook_subscriptions/10002/edit",
    "external_record_id": null,
    "company_id": 10003,
    "user_id": 10004,
    "target_url": "https://hooks.example.com/trackdrive",
    "event": "new_call",
    "trigger_fields": {
      "schedule_id": null,
      "traffic_source_id": null,
      "offer_id": null,
      "buyer_converted": null,
      "has_recording": null,
      "either_converted": null,
      "buyer_id": null,
      "offer_converted": true,
      "number_id": null,
      "token_list": null
    }
  },
  "metadata": {
    "root": "subscription"
  }
}

GET /subscriptions/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/subscriptions/:id

Get a subscription

Retrieve a single webhook subscription by id.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "subscription": {
    "id": 10001,
    "type": "WebhookSubscription",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "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_subscriptions/10002",
    "routes_edit_path": "/webhook_subscriptions/10002/edit",
    "external_record_id": null,
    "company_id": 10003,
    "user_id": 10004,
    "target_url": "https://crm.example.com/webhooks/new-call",
    "event": "new_call",
    "trigger_fields": {
      "schedule_id": null,
      "traffic_source_id": null,
      "offer_id": null,
      "buyer_converted": null,
      "has_recording": null,
      "either_converted": null,
      "buyer_id": null,
      "offer_converted": null,
      "number_id": null,
      "token_list": null
    }
  },
  "metadata": {
    "root": "subscription"
  }
}

PUT /subscriptions/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/subscriptions/:id

Update a subscription

Change the target_url, event, or trigger_fields on an existing subscription.

Params

Param name Description

Param name	Description
target_url Optional	The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered. Must be a valid URL.
event Optional	The event that will be triggered. EG: When a new call comes in. Must be one of: `new_call`, `call_ringing`, `call_forwarded`, `call_ended`, `call_changed`, `new_lead`, `lead_ended`, `lead_converted`, `lead_opted_out`, `lead_changed`, `incoming_text_message`.

target_url
Optional

The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.

Must be a valid URL.

event
Optional

The event that will be triggered. EG: When a new call comes in.

Must be one of: new_call, call_ringing, call_forwarded, call_ended, call_changed, new_lead, lead_ended, lead_converted, lead_opted_out, lead_changed, incoming_text_message.

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/subscriptions/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "event": "call_ended"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "subscription": {
    "id": 10001,
    "type": "WebhookSubscription",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "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_subscriptions/10002",
    "routes_edit_path": "/webhook_subscriptions/10002/edit",
    "external_record_id": null,
    "company_id": 10003,
    "user_id": 10004,
    "target_url": "https://hooks.example.com/trackdrive",
    "event": "call_ended",
    "trigger_fields": {
      "schedule_id": null,
      "traffic_source_id": null,
      "offer_id": null,
      "buyer_converted": null,
      "has_recording": null,
      "either_converted": null,
      "buyer_id": null,
      "offer_converted": true,
      "number_id": null,
      "token_list": null
    }
  },
  "metadata": {
    "root": "subscription"
  }
}

DELETE /subscriptions/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/subscriptions/:id

Delete a subscription

Permanently remove a subscription. It will stop receiving event payloads.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/subscriptions/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 204

DELETE /subscriptions

Authorization Required

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

Delete a subscription matching a target_url

Remove the subscription matching the given target_url instead of an id, useful when you only know the URL you registered and not its id.

Params

Param name	Description
target_url Optional	The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered. Must be a String

Param name

Description

target_url
Optional

The unique auto-generated subscription URL where Trackdrive will send JSON data when the event is triggered.

Must be a String

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/subscriptions/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "target_url": "https://hooks.example.com/trackdrive"
}'

Example Response 204