Webhooks Overview
Panora can send notifcations to your backend when the state of an object has changed. We use the concept of events
to represent state changes in any object.
Events
are our way of letting you know when something interesting happens in your projects. When an interesting event occurs, we create a new Event object. For example, when a contact is created in a crm, we create a crm.contact.created
event, and when a contact is updated, we create an crm.contact.updated
event. Certain API requests might create multiple events. For example, after we pull data from a CRM plaftorm you may receive both a crm.contact.pulled
event and some crm.contact.created
events.
Events occur when the state of another API resource changes. The event’s data field embeds the resource’s state at the time of the change. For example, a crm.contact.updated
event contains a CRM Contact
, as the state of the contact is after the update.
When creating webhook endpoints to retrieve events from Panora, you have the flexibilty to only retrieve some events, for each endpoint. We also have a separate webhooks system for sending the Event objects directly to an endpoint on your server. You can manage webhooks in your account settings. Learn how to listen for events so that your integration can automatically trigger reactions.
The event Object
The event
object is used to represent an existing change to an object.
The typical implementation consists in listening for events and triggering worklows in your backend based on the content of the field type and data of the webhook.
Properties
Securing your webhooks
We use secrets to make sure your endpoints do not receive data from third-parties usurpating Panora.
List of Event Types
This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.
You’ll notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against.