/webhooks/v1alpha1/jobEvents

Tamr can publish notifications for job events to a user-specified endpoint (a webhook). For each event, the notification includes:

  • Job ID.
  • Job type.
  • Related resource ID and name.
  • Current job status (PENDING, RUNNING, STOPPING, or DONE) and the time the job entered this status.
  • Past statuses for this job.

Resource Identifiers in Events

Job events include the resource ID and name for the source, data product, workflow, publish configuration, or destination for which the job ran.

Note for legacy data products: For legacy data products, the update data product job event only includes the dataProductId, and the publish configuration job event only includes the destinationId.

Depending on the type of job being run, some empty identifier fields may be included in the event.

Job TypeReturned Identifier ValuesReturned Empty Identifier Values
Load sourcesourceId
sourceDisplayName
None
Update data productdataProductId
dataProductDisplayName
workflowId
workflowDisplayName
Update workflowworkflowId
workflowDisplayName
dataProductId
dataProductDisplayName
Publish configuration
(batch)
dataProductId
dataProductDisplayName
destinationId
destinationDisplayName
Publish destinationdestinationId
destinationDisplayName
dataProductId
dataProductDisplayName

DONE State for Stopped or Failed Jobs

DONE state indicates that the job is finished successfully, was stopped (canceled), or failed.

If a job was stopped or failed, the event includes an error message.

Example message for stopped job:

"status": {  
      "state": "DONE",  
      "stateStartTime": "2025-12-02T14:46:04.518Z",  
      "error": {  
        "reason": "STOPPED_BY_USER",  
        "message": "The job was stopped by a user."  
      }  
    }

Example message for a job that failed during planning:

"status": {  
      "state": "DONE",  
      "stateStartTime": "2025-12-02T14:46:04.518Z",  
      "error": {  
        "reason": "PLANNING_FAILED",  
        "message": "Something went wrong while planning the job. Please verify the configuration is correct and try again."  
      }  
    }

© 2025, Tamr, Inc. All rights reserved.

License Agreement | Privacy Policy | Data Security Policy| AI Chatbot Disclaimer