Skip to main content

Receiving webhook data

Payload Reference​

The Webhook Service accepts an arbitrary payload for each posted event. However, for integration purposes, certain properties are expected to be included in the payload object by other services Below are those properties detailed. Note that these are inclusive, so additional properties are allowed.

The data will always be formatted in this manner:

{
  "event": "UPDATE_ACCOUNT",
  "data": {},
}

The event field will tell you which type of webhook event it is and the data field will change dynamically depending on the resource for this event. Below is a link to the reference for the resource that is sent with each event.

Activity event​

Given an activity event CREATE_ACTIVITY, UPDATE_ACTIVITY or DELETE_ACTIVITY.

See Gateway API reference for Activity.

Opportunity event​

Given an opportunity event CREATE_OPPORTUNITY, UPDATE_OPPORTUNITY or DELETE_OPPORTUNITY.

See Gateway API reference for [Opportunity]((https://docs.cirruscrm.io/docs/graphql/objects/opportunity).

Account event​

Given an account event CREATE_ACCOUNT, UPDATE_ACCOUNT or DELETE_ACCOUNT.

See Gateway API reference for Account.

Contact event​

Given an contact event CREATE_CONTACT, UPDATE_CONTACT or DELETE_CONTACT.

See Gateway API reference for Contact.