Get Notified of Changes in Your CRM
This guide covers setting up events, which you can use to track changes in your connected CRM data.
Setup Environment
Before you can set up events in Grid Squid, you need to have set up the Grid Squid environment.
Please follow steps in either of the below Quick Start guides to setup your environment:
Configure an Event - Using the UI
In order to configure an event using Grid Squid's UI:
- Go to 'USERS' and select 'EVENT CONFIGURATION' for a specific user.
- Hit 'SET UP A NEW EVENT CONFIG'.
Then, you'll need to configure your EVENT:
- Select the Object you want to configure the event for (Grid Squid will check for updates in corresponding CRM object).
- Input the URL that you want Grid Squid to send a notification to whenever there is an update.
- Set the polling time (Grid Squid will check for updates to the object at this time interval).
Configure an Event - Using the API
To configure an event to monitor changes in a specific CRM object, make a POST request to:
<YOUR_API_URL>/event-configurations
Your request body (params) should look like this:
{
“user_id”: ID of user for whom this event is being configured,
“mapping_id”: ID of mapping for which this event is being configured,
“Polling_time_minutes”: time interval for Grid Squid to check CRM for updates,
“notification_webhook_url”: URL where Grid Squid should send the notifications,
“enabled”: True (event is active) or Falses (event is deactivated)
}
Request Parameters
- YOUR_API_ URL: This is the URL to access the unified Grid Squid API provided by us after you have signed up.
- user_id: This is the id of the user whose CRM account will be accessed to pull the requested data (objects). You can get the user_id either by going to the users section in the UI or by making a GET request to pull the user information as mentioned in the API Reference.
- mapping_id: This is the id of the mapping created for a specific CRM object which you want to monitor. This will usually be something like accounts, contacts, leads etc. You can get the mapping_id by making a GET request to pull all the mapping information as mentioned in the API Reference.
- Polling_time_minutes: This is time interval, in minutes, that defines how often Grid Squid will check for any changes in the specified CRM object.
- notification_webhook_url: This is the URL of your choice where Grid Squid will send notifications whenever there is any change in the specified CRM object.
- enabled: This is a boolean variable, set to True if the event is active, and set to False when the event is deactivated.
Expected Response
Successful POST requests will configure the event, and will return the event_id along with all the configuration details as show below:
{
"user_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mapping_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"polling_time_minutes": 5,
"notification_webhook_url": "https://mydomain.com/my-webhook",
"enabled": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Response Parameters
id: This is the id the of newly configured event, you can use this to get more details, update or delete the event in future.
All the other parameters are same as the ones set in the request body.
For definitions of common CRM terminologies used by Grid Squid, like Objects, Fields, and Records, please check out the Grid Squid Glossary.
For more detailed information on how to use the Grid Squid API, along with code samples, please check out our API Reference.
