Event Notifications
Typically when using Composer API solutions, in order to determine if the merge has completed or encountered a failure, a user must use a GET status request to poll the merge operation. This requires more API usage and maintaining more complicated solutions.
Event Notifications can be enabled in order to receive updates when Composer API merges succeed or fail.
Enable Event Notifications
- Navigate to
- In the Event Notification Management window, you can see the Dashboard information and a list of Event Notifications Callbacks.
- Click the +New Event button in the upper-right corner.
- In the Create New Event Notification window, select Composer as the Product option from the dropdown list.
- Enter a Callback Name and input your webhook Callback URL.
- Under the Events menu, the Composer Merge Events section has the Merge Complete option selected by default.
- Select Authentication to select your Authentication type, Basic or Oauth 2.0.
- For Basic Authentication, input your Username and Password.
- For Oauth 2.0, input your Client ID, Client Secret and Authentication Server URL.
- Lastly, select Payload to configure your JSON Payload to be sent to the callback URL.
- Click Create.
Using CustomContext with Event Notifications
You can use the customContext parameter in your merge request to pass transaction IDs, Salesforce object references, file path/locations, and other metadata used for downstream processing.
Example JSON for a merge request with customContext:
{
"eventType": "merge.status",
"source": "composer",
"version": "v1",
"timestamp": "2026-03-24T20:20:24.675Z",
"correlationId": "cor-09Xu2f",
"payload": {
"templateId": "T-123"
"documentId": 43191874,
"status": "completed"
"customContext": {
"salesforceObjectId": "006ZYX123GHA012",
"templateIds": "["SFTmpl01", "SFTmpl02"],
"packetType:" "InsuranceQuote",
"saveDestination": "s3://my-bucket/InsQuotes/2026/05/",
},
},
} Using a Failed Event Notification
You can use the following Event Notification as an example for when you attempt to merge and the merge event encounters a failure.
{
"publisher": "composer",
"eventName": "merge.failed",
"orgId": "441ffc92-d3da-4b05-a4e2-f72e8158431e",
"eventData": {
"CorrelationId": "d0fda2efaf854753aa176e8aac574523_DatasetJson",
"Status": "Failure",
"Timing": {
"createdDate": "2026-09-30T18:11:26.1313884Z",
"completedDate": "2026-09-30T18:11:33.9988195Z",
"durationMs": 7867 },
"Error": {
"Code": "500",
"Category": "Other",
"Message": "Cannot find column 0." }
},
"customContext": {
"source": "postman-test",
"requestId": "QA-20722-001",
"opportunityId": "006dM00000AbCdEQAZ" }
}