API documentation

GET /integrations

Authorization Required

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

List Integration records.

Lists the third-party integrations configured for the company. Restricted to superusers with the integrations permission; supports filtering by ids and standard pagination.

Params

Param name	Description
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 a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. 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 integration_type name public_key category category_name connected_status connected_at disconnected_at is_oauth2 cache_expires_in requests_24h supports_sync 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: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "integration/facebook_leadads_integrations": [
    {
      "id": 10001,
      "type": "Integration",
      "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": null,
      "routes_edit_path": "/integrations/10002/edit",
      "external_record_id": null,
      "integration_type": "facebook_leadads",
      "name": "Facebook Lead Ads",
      "public_key": null,
      "category": "leadgen",
      "category_name": "Lead Gen",
      "connected_status": null,
      "connected_at": null,
      "disconnected_at": null,
      "is_oauth2": false,
      "cache_expires_in": 900,
      "requests_24h": 0,
      "supports_sync": false
    },
    {
      "id": 10003,
      "type": "Integration",
      "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": null,
      "routes_edit_path": "/integrations/10004/edit",
      "external_record_id": null,
      "integration_type": "google_adwords",
      "name": "Google Ads",
      "public_key": null,
      "category": "tracking",
      "category_name": "Conversion Tracking",
      "connected_status": null,
      "connected_at": null,
      "disconnected_at": null,
      "is_oauth2": true,
      "cache_expires_in": 900,
      "requests_24h": 0,
      "supports_sync": false
    }
  ],
  "metadata": {
    "root": "integration/facebook_leadads_integrations",
    "page": 1,
    "total_pages": 4,
    "per_page": 2,
    "total_count": 8,
    "next_cursor": 10005
  }
}

PUT /integrations/objects/:id

Authorization Required

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

Update the status of an Integration Object.

Enables or disables a single synced object (an Integration Object) belonging to an integration, such as turning a connected item on or off. Requires the integrations permission.

Params

Param name	Description
active Optional	Enable or disable an integration object. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Param name

Description

active
Optional

Enable or disable an integration object.

Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /integrations/new

Authorization Required

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

Build Integration with defaults.

Returns a blank Integration populated with default attributes for the given integration_type, without saving it. Use it to preview the fields required before creating one.

Params

Param name	Description
integration_type Optional	Integration Type Must be one of: `blacklist_alliance`, `eleven_labs`, `facebook_capi`, `facebook_leadads`, `google_adwords`, `infusionsoft`, `mailchimp`, `mailgun`, `pagerduty`, `salesforce`, `sendgrid`, `slack`, `snapchat_capi`, `tcpa_shield`, `tiktok_capi`, `typeform`, `zadarma`, `zoho_crm`.
name Optional Blank value allowed	A friendly name for this integration, shown when managing your integrations. Must be a String
description Optional Blank value allowed	A note describing what this integration is used for. Must be a String
public_key Optional Blank value allowed	The public API key issued by the connected service, used to authenticate requests to it. Must be a String
secret_key Optional Blank value allowed	The secret API key issued by the connected service, used to authenticate requests to it. Must be a String
pagerduty_integration_key Optional Blank value allowed	The integration key (routing key) from your PagerDuty service, used to send it alerts. Must be a String
slack_webhook_url Optional Blank value allowed	The incoming webhook URL from your Slack workspace, used to post messages to it. Must be a String
cache_expires_in Optional Blank value allowed	The number of seconds a lookup result from this integration is cached before it is requested again. Must be a decimal number.
always_trigger Optional Blank value allowed	When true, this integration fires for every matching event instead of only events matching its trigger fields. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/integrations/new?integration_type=salesforce' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "salesforce_integration": {
    "id": null,
    "type": "Integration",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "integration_type": "salesforce",
    "name": "Salesforce",
    "public_key": null,
    "category": "crm",
    "category_name": "CRM Software",
    "connected_status": null,
    "connected_at": null,
    "disconnected_at": null,
    "is_oauth2": false,
    "cache_expires_in": 900,
    "requests_24h": 0,
    "supports_sync": false
  },
  "metadata": {
    "root": "salesforce_integration"
  }
}

POST /integrations

Authorization Required

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

Create Integration.

Creates a new Integration of the given integration_type for the company. Restricted to superusers with the integrations permission.

Params

Param name	Description
integration_type Optional	Integration Type Must be one of: `blacklist_alliance`, `eleven_labs`, `facebook_capi`, `facebook_leadads`, `google_adwords`, `infusionsoft`, `mailchimp`, `mailgun`, `pagerduty`, `salesforce`, `sendgrid`, `slack`, `snapchat_capi`, `tcpa_shield`, `tiktok_capi`, `typeform`, `zadarma`, `zoho_crm`.
name Optional Blank value allowed	A friendly name for this integration, shown when managing your integrations. Must be a String
description Optional Blank value allowed	A note describing what this integration is used for. Must be a String
public_key Optional Blank value allowed	The public API key issued by the connected service, used to authenticate requests to it. Must be a String
secret_key Optional Blank value allowed	The secret API key issued by the connected service, used to authenticate requests to it. Must be a String
pagerduty_integration_key Optional Blank value allowed	The integration key (routing key) from your PagerDuty service, used to send it alerts. Must be a String
slack_webhook_url Optional Blank value allowed	The incoming webhook URL from your Slack workspace, used to post messages to it. Must be a String
cache_expires_in Optional Blank value allowed	The number of seconds a lookup result from this integration is cached before it is requested again. Must be a decimal number.
always_trigger Optional Blank value allowed	When true, this integration fires for every matching event instead of only events matching its trigger fields. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/integrations/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "integration_type": "facebook_leadads",
  "name": "Example Facebook Lead Ads Integration",
  "description": "Integration created for API documentation examples"
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "facebook_leadads_integration": {
    "id": 10001,
    "type": "Integration",
    "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": null,
    "routes_edit_path": "/integrations/10002/edit",
    "external_record_id": null,
    "integration_type": "facebook_leadads",
    "name": "Example Facebook Lead Ads Integration",
    "public_key": null,
    "category": "leadgen",
    "category_name": "Lead Gen",
    "connected_status": null,
    "connected_at": null,
    "disconnected_at": null,
    "is_oauth2": false,
    "cache_expires_in": 900,
    "requests_24h": 0,
    "supports_sync": false
  },
  "metadata": {
    "root": "facebook_leadads_integration"
  }
}

GET /integrations/:id

Authorization Required

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

Get Integration by id.

Retrieves a single Integration by id, scoped to your company.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "facebook_leadads_integration": {
    "id": 10002,
    "type": "Integration",
    "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": null,
    "routes_edit_path": "/integrations/10001/edit",
    "external_record_id": null,
    "integration_type": "facebook_leadads",
    "name": "Facebook Lead Ads",
    "public_key": null,
    "category": "leadgen",
    "category_name": "Lead Gen",
    "connected_status": null,
    "connected_at": null,
    "disconnected_at": null,
    "is_oauth2": false,
    "cache_expires_in": 900,
    "requests_24h": 0,
    "supports_sync": false
  },
  "metadata": {
    "root": "facebook_leadads_integration"
  }
}

PUT /integrations/:id

Authorization Required

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

Update Integration by id.

Updates an existing Integration's configuration by id, such as its credentials or connection settings.

Params

Param name	Description
integration_type Optional	Integration Type Must be one of: `blacklist_alliance`, `eleven_labs`, `facebook_capi`, `facebook_leadads`, `google_adwords`, `infusionsoft`, `mailchimp`, `mailgun`, `pagerduty`, `salesforce`, `sendgrid`, `slack`, `snapchat_capi`, `tcpa_shield`, `tiktok_capi`, `typeform`, `zadarma`, `zoho_crm`.
name Optional Blank value allowed	A friendly name for this integration, shown when managing your integrations. Must be a String
description Optional Blank value allowed	A note describing what this integration is used for. Must be a String
public_key Optional Blank value allowed	The public API key issued by the connected service, used to authenticate requests to it. Must be a String
secret_key Optional Blank value allowed	The secret API key issued by the connected service, used to authenticate requests to it. Must be a String
pagerduty_integration_key Optional Blank value allowed	The integration key (routing key) from your PagerDuty service, used to send it alerts. Must be a String
slack_webhook_url Optional Blank value allowed	The incoming webhook URL from your Slack workspace, used to post messages to it. Must be a String
cache_expires_in Optional Blank value allowed	The number of seconds a lookup result from this integration is cached before it is requested again. Must be a decimal number.
always_trigger Optional Blank value allowed	When true, this integration fires for every matching event instead of only events matching its trigger fields. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/integrations/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Facebook Lead Ads Integration (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "facebook_leadads_integration": {
    "id": 10002,
    "type": "Integration",
    "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": null,
    "routes_edit_path": "/integrations/10001/edit",
    "external_record_id": null,
    "integration_type": "facebook_leadads",
    "name": "Example Facebook Lead Ads Integration (renamed)",
    "public_key": null,
    "category": "leadgen",
    "category_name": "Lead Gen",
    "connected_status": null,
    "connected_at": null,
    "disconnected_at": null,
    "is_oauth2": false,
    "cache_expires_in": 900,
    "requests_24h": 0,
    "supports_sync": false
  },
  "metadata": {
    "root": "facebook_leadads_integration"
  }
}

DELETE /integrations/:id

Authorization Required

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

Destroy Integration by id.

Permanently deletes an Integration by id, disconnecting it from your company.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "facebook_leadads_integration": {
    "id": 10002,
    "type": "Integration",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": "/integrations/10001/edit",
    "external_record_id": null,
    "integration_type": "facebook_leadads",
    "name": "Example Facebook Lead Ads Integration",
    "public_key": null,
    "category": "leadgen",
    "category_name": "Lead Gen",
    "connected_status": null,
    "connected_at": null,
    "disconnected_at": null,
    "is_oauth2": false,
    "cache_expires_in": 900,
    "requests_24h": 0,
    "supports_sync": false
  },
  "metadata": {
    "root": "facebook_leadads_integration"
  }
}

Params

Must be any combination of:

Params

Params

Params

Params