Skip to main content
GET
/
api
/
data
/
sendflow
/
v1
/
delivery-report
Get Sendflow Delivery Report
curl --request GET \
  --url https://api-ai.zixflow.com/api/data/sendflow/v1/delivery-report \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "success": true,
  "message": "Sendflow delivery report retrieved successfully",
  "data": {
    "request_id": "8cf12de6-0504-41f9-b576-cbdb20b3e275",
    "execution_id": "exec_123456789",
    "status": "completed",
    "statusAt": "2024-01-15T10:30:00Z",
    "email": "user@example.com",
    "phone": "919876543210",
    "remark": "Sendflow executed successfully",
    "workspace_id": "workspace_123"
  }
}

​
Description

This endpoint allows you to retrieve the execution status and details of a Sendflow workflow that was triggered. Use the request_id that was returned when you triggered the Sendflow to get the delivery report.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Query Parameters

​
request_id
string
required
The unique request ID that was returned when the Sendflow was triggered. This ID is used to track the execution status of the workflow.

​
Response

​
success
boolean
Indicates whether the API call was successful.
​
message
string
Success or error message from the API.
​
data
object
The Sendflow delivery report data containing the following fields:
​
data.request_id
string
The request ID that was used to query this report.
​
data.execution_id
string
The unique execution ID for this Sendflow workflow run.
​
data.status
string
The current execution status of the Sendflow workflow.
​
data.statusAt
string
Timestamp indicating when the status was last updated.
​
data.email
string
The email address associated with this Sendflow execution (if applicable).
​
data.phone
string
The phone number associated with this Sendflow execution (if applicable).
​
data.remark
string
Additional remarks or notes about the execution status.
​
data.workspace_id
string
The workspace ID associated with this Sendflow execution.
{
  "success": true,
  "message": "Sendflow delivery report retrieved successfully",
  "data": {
    "request_id": "8cf12de6-0504-41f9-b576-cbdb20b3e275",
    "execution_id": "exec_123456789",
    "status": "completed",
    "statusAt": "2024-01-15T10:30:00Z",
    "email": "user@example.com",
    "phone": "919876543210",
    "remark": "Sendflow executed successfully",
    "workspace_id": "workspace_123"
  }
}