Sync Zendesk Connection API #

Endpoint #

POST /api/data_connections/{connection_id}/sync?from={timestamp}

Description #

This API triggers a forced synchronization of data from Zendesk to FunnelStory. While sync occurs at set intervals in the background, calling this API manually forces an immediate sync.

Request #

URL Parameters #

• connection_id (string, required): Unique identifier for the data connection.
• from (integer, optional): Unix timestamp (seconds) indicating the start time for data fetching.
  • If not provided, the default behavior fetches data from the past 30 days.
  • Cannot be a date in the future.

Response #

Success (200 OK) #

{
  "ok": true,
  "response": {
    "id": "id",
    "data_connection_id": "data_connection_id",
    "started_at": "2025-03-21T08:16:34.861137436Z",
    "ended_at": "2025-03-21T08:16:35.100433349Z"
  }
}

Error Responses #

400 Bad Request #

{
  "ok": false,
  "error": "from time is in the future"
}

500 Internal Server Error #

{
  "ok": false,
  "error": "Internal Server Error"
}

Sync Behavior #

• If a specific from timestamp is provided, the sync operation has a timeout of 1 hour.
• If no from timestamp is provided, the sync operation has a timeout of 5 minutes.

Example Request #

With from parameter #

curl --location --request POST 'https://app.funnelstory.ai/api/data_connections/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/sync?from=1742373900'

Without from parameter #

curl --location --request POST 'https://app.funnelstory.ai/api/data_connections/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/sync'