Skip to main content
ONESOURCE Events
Search
Search Indirect Tax Support Help and Support.

This article applies to:

  • Product: ONESOURCE Indirect Tax,ONESOURCE Indirect Tax Compliance

Using ONESOURCE Events in Indirect Tax Compliance

What is ONESOURCE Events

ONESOURCE Events broadcasts real time updates from ONESOURCE backend systems to ONESOURCE Indirect Tax Compliance. You can subscribe to event feeds and use the data to send notifications or automate workflows with available APIs.
Current feeds include import status, return status, and e-filing status. Future feeds may include configuration changes (for example, entity updates) and audit-related events (for example, datasets created or deleted).
To learn more about ONESOURCE Events, refer to Events in the API Administration Help and Support.
Who can use ONESOURCE Events
  • People with access to
    ONESOURCE API Administration
    .
  • People with permission to set up event endpoints and use the related features (imports, returns, and e-filing).
Before you begin
  • Decide where you want to receive events (for example, a webhook endpoint you control).
  • Verify your endpoint can get POST requests and parse JSON.
  • Verify your ONESOURCE role lets you configure events and perform imports, returns updates, or e-filing.
How events are delivered
  • ONESOURCE Events pushes JSON messages to your configured endpoint in real time.
  • Each message includes metadata (for example,
    id
    ,
    schema
    ,
    channel
    ,
    timestamp
    ) and an
    event
     object with
    headers
     (tenant and client) and a
    payload
     (the business update).

Import status updates

You'll receive real time updates about your file imports without polling multiple APIs. ONESOURCE Events sends an import status update after you submit a file import and ONESOURCE processes it.
What you need
  • Access to
    ONESOURCE API Administration
     and permission to configure event endpoints.
  • Permission to submit imports via the API or the User Interface (UI).
Set up your event endpoint
  1. Go to
    API Administration
    Events
    .
  2. Add your endpoint (URL) where you want to receive import status updates.
  3. Save your changes.
  4. Submit the import via the API or UI to import your file.
    1. ONESOURCE processes the import according to your import rules.
    2. ONESOURCE receives the event, then sends an import status message to your endpoint.
What the response includes
  • Database name
  • Client name
  • Import file name
  • Specification
  • Import status
Benefits
  • Avoid repetitive API calls to check status.
  • Get real time updates as processing progresses.
  • Your integration runs smoothly with fewer checks and less latency.
Sample imported response
{
"id": "689468baa4583054b77ad4b8",
"schema": "updatestatus",
"channel": "global-compliance-imports",
"publisher_id": "1e802a0d-189b-4958-8dac-effc1142c5a0",
"target": "8e9a7f8b-b62b-4592-838e-15c8d4b3bcae",
"timestamp": 1754556602462,
"is_test_event": false,
"event": {
"headers": {
"tenant_id": "BSQ",
"client_id": "0"
},
"payload": {
"name": "Import in progress – 'V3_PM_Imports_Reports_Import.csv', Spec: 'Upload Test Spec'",
"status": "InProgress",
"type": "Imports",
"reference_id": "10967"
  }
}
}

Return status updates

You'll receive real time updates when you change a return’s status, without polling.
ONESOURCE Events
 sends a return status update after you make changes to a return in the API or UI.
What you need
  • Access to
    ONESOURCE API Administration
     and permission to configure event endpoints.
  • Permission to view and update returns.
Set up your event endpoint
  1. Go to
    API Administration
    Events
    .
  2. Add your endpoint to receive return status updates.
  3. Save your changes.
  4. Update the return status via an API or UI.
    1. ONESOURCE processes the return status according to your import rules.
    2. ONESOURCE receives the event, then sends the return status message to your endpoint.
What the response includes
  • Database name
  • Client name
  • Return name
  • Return status
  • Return type
Benefits
  • Avoid repetitive API calls for status changes.
  • Get immediate notifications that you can route to downstream systems.
Sample return event
{
"id": "68946e96935cfb49ad566788",
"schema": "updatestatus",
"channel": "global-compliance-imports",
"publisher_id": "b8e088e2-76dd-401c-8180-3e42ddf3fe82",
"target": "81fd4b72-cf12-425e-9324-4af7c9ead720",
"timestamp": 1754558102783,
"is_test_event": false,
"event": {
"headers": {
"tenant_id": "VNK",
"client_id": "115" },
"payload": {
"name": "17290_NL_E 01/01/2011 - 30/10/2022",
"status": "Final",
"type": "Returns",
"reference_id": "4506b09e-4fb9-41b5-a4ef-d5750c002721"
 }
}
}

E-filing status updates

You'll receive real time updates on return e-filing status across jurisdictions supported by ONESOURCE Indirect Tax Compliance (excluding Australia Business Activity Statement).
ONESOURCE Events sends an e-filing status update after you e-file a return and ONESOURCE receives status from the tax authority integration.
What you need
  • Access to
    ONECOURCE API Administration
     and permission to configure event endpoints.
  • Permission to e-file returns in OIC.
Set up your event endpoint
  1. Go to
    API Administration
    Events
    .
  2. Add your endpoint to receive e-filing status updates.
  3. Save your changes.
  4. Submit the e-filing via API or UI to e-file the return.
    1. ONESOURCE transmits to the tax authority and processes the response.
    2. ONESOURCE Events sends the e-filing status message to your endpoint.
What the output includes
  • Database name
  • Client name
  • Return name
  • E-filing status
  • Filing type
Benefits
  • Avoid repetitive API calls for tax authority status.
  • Get real time confirmations you can use to drive downstream workflows.
Sample e-filing status event
{
"id": "68946e96935cfb49ad566788",
"schema": "updatestatus",
"channel": "global-compliance-imports",
"publisher_id": "b8e088e2-76dd-401c-8180-3e42ddf3fe82",
"target": "81fd4b72-cf12-425e-9324-4af7c9ead720",
"timestamp": 1754558102783,
"is_test_event": false,
"event": {
"headers": {
"tenant_id": "VNK",
"client_id": "115"
},
"payload": {
"name": "17290_NL_E 01/01/2011 - 30/10/2022",
"type": "Returns",
"reference_id": "4506b09e-4fb9-41b5-a4ef-d5750c002721",
"status": "Final" headers {"tenant_id":"GFX","client_id":"10"}    
 }
}
}

Related Content