Webhooks

Why Webhooks?

Webhooks are an easy way to receive push notifications in your app about new events that happen within Officient.

How to set up

Webhooks can be set up via the Officient admin interface under settings => Integrations => Webhooks

Notification content

Officient will execute a POST request to the provided URL. The POST body of the request will look like this:

{ 
  "account": "your_account_name",
  "event_type" : "person_added",
  "related_object_id" : "123456" 
}

event_type: type of the event (String)
related_object_id: ID of the object (String)

Delivery

Officient will attempt to re-submit the notification if the first request was not successful. A request is deemed unsuccessful if HTTP status other than 200 is returned or if a timeout occurs.