Tamr’s event-driven notification system enables you to keep all of your systems up to date with the golden records in the Tamr System of Record (SOR).

Tamr can publish Realtime notifications for these logical actions to a user-specified endpoint (a webhook):

• Create golden record
• Update golden record
• Delete golden record
• Merge golden record
• Unmerge golden record
• Enrich golden record

The notifications are published as HTTPS POST requests. The webhook receives these requests and sends messages with the event data to a subscribing application or portal. For example, when a new record is created in the SOR, Tamr publishes a notification to the specified webhook, which then sends the CREATE event to a consumer application such as a CRM.

Merge and Unmerge Logical Actions

For golden record merge actions, an UPDATE event is published to update the data in the surviving golden record. A DELETE event is sent for the retired golden record. These two physical events are grouped together as one logical event by the same versionId value. They are ordered by two different values for recordNumber.

For golden record unmerge actions, an UPDATE event is published to update the data in the surviving golden record. A CREATE event is sent for the previously retired (resurrected) record golden record. These two physical events are grouped together as one logical event by the same versionId value. They are ordered by two different values for recordNumber.

Example Webhook Events

Webhook Requirements

Client Webhook Requirements

Your organization must have an HTTPS endpoint that can capture the change data sent from Tamr Cloud via HTTPS POST.

The endpoint service must:

• Support throughput commensurate with the user’s Tamr RealTime authoring throughput. Tamr publishes notifications in near real-time as authoring events occur in the SOR.
• Be capable of processing requests idempotently, which allows Tamr to safely replay the messages from a given time range as needed.

Webhook Integration Requirements

When configuring a webhook integration, you must provide an authorization header value for Tamr to use to access your webhook endpoint. For example:

• A basic auth header (BasicCreds)
• An API key header (X-API-KEY)

Tamr also supports using token authentication with optional JWT assertion (RSA_256 algorithm only) when accessing the webhook endpoint.

The token provider must adhere to the official OAuth2 Authorization Framework specification for the client_credentials grant type, found here: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.3

Configuring a Webhook Integration

To add a connection to your webhook endpoint:

1. Navigate to Admin Center > Connections.
2. Select New Connection.
3. Choose the Webhook connection type.
4. Provide the webhook URL and enter each header value as a key/value pair. Choose the Sensitive option to hide the value in the Tamr Cloud UI. Examples of key/value pairs:
   • Authorization: Basic
   • Content-Type: application/json
5. Optionally, enable Use Token Authentication and enter the following:
   • Token Provider URL: A request will be made to this URL to obtain a token, which will then be sent as the bearer token in the Authorization header of the webhook request.
   • Grant Type: The default value is client_credentials.
   • Content Type: Choose either application/x-www-form-urlencoded or application/json.
   • Client ID and Client Secret: Client credentials to use when making the request to the token provider. Choose whether to include these credentials in the header.
6. If using token authentically, optionally enable Use JWT Assertion and enter the following:
   • JWT Private Key: This value is visible only when initially configuring the webhook connection. It is hidden when editing this connection.
   • JWT Audience: The resource server that is the audience receiving the JWT.
   • JWT Time-to-Live (seconds): The amount of time in seconds to allow for validating JWT expiration time and issued at claims.
   • JWT Algorithm: Tamr supports only RSA_256.
7. Select Add to save the webhook.

Webhook Payload Format

Webhook payloads follow the CloudEvents standard. CloudEvents is a specification for describing event data in a common format to provide interoperability across services, platforms and systems. The CloudEvents specification defines a standard envelope for event data. For ease of adoption, CloudEvents SDKs are available in a variety of languages.