1. Data Workflows
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Rewards & Redemptions
    • Store catalog to redemptions
    • List redemption orders by custom-field identifier
      POST
    • Update redemption order status or refund
      PUT
    • Create redemption order status
      POST
    • List redemption orders by user email
      POST
    • List redemption statuses
      POST
    • Get redemption status by ID
      POST
    • List redemption orders by community
      POST
    • Get redemption order status history
      POST
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
    • Get bulk update job status
    • Get bulk update job details
    • Bulk update users from CSV
    • Bulk update premium currency from CSV
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • User Fields
    • User field definitions and history
    • User Field History
      • Get all user field histories in a community
      • Get user field histories for a specific field
      • Get user field histories for a specific user
      • Get user field histories of specific user field and user
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Get A User Field Definition
    • Update A User Field Definition
    • Create A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  • Data Workflows
    • Read event-ingest lifecycle status by trigger and batch ID.
      GET
  1. Data Workflows

Read event-ingest lifecycle status by trigger and batch ID.

GET
https://uat-integration.returning.ai/apis/v1/data-workflows/event-ingests/status

Data Workflow Ingest Status Lookup#

What this endpoint does#

Reads the processing lifecycle for an asynchronously ingested Data Workflow batch. Use the trigger_id and client-provided metadata.batch_id to check whether the batch is pending, queued, processing, processed, skipped, orphaned, or failed.
This endpoint only reads the persisted event_ingest status. It does not submit or queue an ingest request, wait for workflow execution, or return row-level results. A successful ingest submission means the request was accepted for asynchronous processing; it does not mean processing has completed.
INFO
Workflow
Submit an ingest request with trigger_id and metadata.batch_id → receive queue acceptance → call GET /apis/v1/data-workflows/event-ingests/status with the same trigger_id and batch_id → poll until the status is terminal → inspect error and counts.

Quick start#

Authentication and permission#

Send Authorization: Bearer <COMMUNITY_API_KEY>. The community API key must belong to the community that owns the Data Workflow trigger and include the dataWorkflows permission. Keep the key server-side.
The lookup is scoped to the authenticated key's community, so a key cannot read another community's ingest status.

Request#

Method: GET
Path: /apis/v1/data-workflows/event-ingests/status
Query parameterTypeRequiredDescription
trigger_idstringYesA 24-character hexadecimal Data Workflow event-ingest trigger ObjectId.
batch_idstringYesThe client batch ID supplied in the ingest payload as metadata.batch_id. It must contain at least one non-whitespace character.

Success response#

HTTP 200. The response describes the persisted batch lifecycle record. Missing historical count values are returned as 0; missing timestamps are returned as null.
{
  "trigger_id": "6a43d5141d4be4089b58e2e7",
  "batch_id": "batch-2026-07-01-040",
  "status": "processed",
  "received_at": "2026-07-01T01:28:35.000Z",
  "processed_at": "2026-07-01T01:58:42.000Z",
  "accepted_record_count": 1,
  "skipped_record_count": 0,
  "error": null
}
PropertyTypeDescription
trigger_idstringThe trigger ID used for the lookup.
batch_idstringThe client-provided batch ID used for the lookup.
statusstringCurrent persisted lifecycle status: pending, queued, processing, processed, skipped, orphaned, or failed. Internal normalized records are returned as processed.
received_atstring | nullISO 8601 time when the ingest was first durably persisted.
processed_atstring | nullISO 8601 time when processing completed, when available.
accepted_record_countnumberNumber of accepted records, or 0 when the stored row has no count.
skipped_record_countnumberNumber of skipped records, or 0 when the stored row has no count.
errorobject | nullnull when no stored failure or skip reason is available. Otherwise includes a stable code and stored message.
Failed and orphaned records return an error such as:
{
  "code": "INGEST_FAILED",
  "message": "Record idempotency requires a JSON data[] row payload."
}
Skipped records with a stored skip reason return code: "INGEST_SKIPPED" and the reason in message.

Errors and recovery#

StatusCodeWhenRecovery
400INVALID_TRIGGER_IDtrigger_id is missing, malformed, or not a string.Send the trigger's 24-character hexadecimal ObjectId.
400MISSING_BATCH_IDbatch_id is missing, blank, or not a string.Send the same non-empty metadata.batch_id used when submitting the ingest.
401AUTHENTICATION_REQUIREDThe community API key is missing or invalid.Send a valid community API key in the Authorization header.
401—The community API key is missing the required permission.Use a key for the trigger's community with the dataWorkflows permission.
401COMMUNITY_CONTEXT_MISSINGAuthentication did not provide a valid community context.Use a valid community API key and retry.
404EVENT_INGEST_NOT_FOUNDNo persisted status record matches this community, trigger, and batch.Verify both IDs. A just-accepted request may not have been persisted yet; retry after a short delay.
500EVENT_INGEST_STATUS_LOOKUP_FAILEDThe service could not read the status record.Retry with bounded backoff; contact support if the error persists.
Error response example:
{
  "code": "EVENT_INGEST_NOT_FOUND",
  "message": "No event ingest was found for the supplied trigger_id and batch_id."
}

Retry safety and gotchas#

This is a read-only GET; retry timeouts with bounded backoff. Repeating the lookup does not enqueue another ingest.
batch_id is matched to the request-level batch idempotency record. A repeated duplicate batch can resolve to its skipped audit record.
There may be a short delay between queue acceptance and persistence of the event_ingest record. During that gap, lookup returns 404; retry after a short delay.
Status is the ingest lifecycle, not proof that every downstream workflow action succeeded.
This endpoint returns batch summary fields only. It does not return payload rows or row-level errors.

Request

Query Params

Responses

🟢200OK
application/json
Request completed successfully.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://uat-integration.returning.ai/apis/v1/data-workflows/event-ingests/status?trigger_id=undefined&batch_id=undefined'
Response Response Example
200 - Example 1
{}
Modified at 2026-09-25 05:16:03
Previous
Update integration API key
Built with