API Integration lets you extend DataGroomr and integrate external systems by providing three options,
- Webhooks - for listening for events in your DataGroomr account so your integration can automatically trigger reactions.
- Handlers - to override DataGroomr's behavior for standard actions like merging.
- Ingestion API - to trigger actions in DataGroomr programmatically from external systems.
Let's look at these three options and their use cases.
1. Webhooks
DataGroomr uses webhooks to notify your application when an event happens in your account.
Begin using webhooks with your DataGroomr integration in just two steps:
- Create an endpoint on your server
- Register the endpoint with DataGroomr
What are webhooks?
Webhooks refers to a combination of elements that collectively create a notification and reaction system within a larger integration.
Metaphorically, webhooks are like a phone number that DataGroomr calls to notify you of activity in your DataGroomr account. The activity could be the merge or convert of Salesforce records. The webhook endpoint is the person answering that call who takes actions based upon the specific information it receives.
Non-metaphorically, the webhook endpoint is just more code on your server, which could be written in any programming language. The webhook endpoint has an associated URL (e.g., https://example.com/webhooks). The DataGroomr notifications are Event objects in JSON format. This Event object contains the relevant information about what just happened, including the type of event and the data associated with that event.
Read more: Webhooks
2. Handlers
Handler is a mechanism to override standard functionality of DataGroomr. At the moment, you can override the behavior of the merge. For example, upon duplicates detection, instead of merging records in Salesforce, you can send records data to your own server or a unique endpoint on your Salesforce and handle it with the custom APEX code.
Read more: Handlers
Overriding standard Merge method using Apex
Can I merge contacts in Nonprofit Success Pack (NPSP)?
3. Ingestion API
Ingestion API can be used to create datasets in Importr, send data to datasets, run analysis, imports and updates programmatically.
Learn more: Ingestion API and secret keys
Leverage the API to verify phones, emails and mailing addresses within forms, external systems and automated bulk verifications. Values verified through the API will be reflected inside of Salesforce if sync is enabled.
Learn more: Verifications API
Records API endpoint allows to get a list of matched and unmatched records. It’s available for Trimmr and Importr datasets, although it will be particularly useful in combination with Ingestion API, where after submission of CSV records for duplicate detection, you’ll be able to get a response of what records were matched and which records are new.
Learn more: Records API
Accessing API Integration
The API integration configuration can be accessed directly by pressing the API Integration link located under the Supervisr tab in the Navigation Menu.
Next steps:
Test Endpoint