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 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.

See Using Tamr RealTime Event Notifications for more details the notifications published for different events.

Configure webhook integrations in the Admin Center.

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)

Configuring a Webhook Integration

To add a connection to your webhook endpoint:

1. Navigate to Admin Center > Webhooks.
2. Select New Webhook.
3. 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
4. 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.
5. 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.
6. Select Add to save the webhook.

Disabling (Pausing) Webhooks

You can disable webhook event notifications on the Webhooks page. This is useful, for example, to avoid sending a large number of events to the webhook when testing a configuration change.

Re-enable the webhook when you are ready to resume sending event notifications.