Account Webhook
RevOps keeps your business informed of key events in your customer lifecycle by sending webhook requests for each important event.
With every change to an Account in RevOps, an event will automatically be sent to each webhook that you have configured to receive account
events.
URLs for webhooks are configured in your RevOps instance inside /integrations/webhooks/setup
Types of Webhook Events
|Webhook Event | Description | Attached Model |
|-|-|
| account-created | When an account is first created. Usually with a draft
status. | Account |
| account-deleted | When an account has been deprovisioned. | Account |
| account-updated | When an account property has been updated. | Account |
HTTP Response Format
All HTTP responses are sent with content-type of application/json
. Each request will contain
an AccountEvent object
Content-Type: application/json
{
"event": {
"time": "1562205650",
"type": "account-created",
"hash": "014a553c12d5942181411b0ef4f74c6cc8f6462023c3aa943fc94b6e33e8988e",
},
"account": {
...
}
}
Account Event
An Account Event contains everything you need to know about the change that occured to your customer. The list of properties for Account Event are:
Name | Type | Description |
---|---|---|
account_id | string | The customer account id |
blocked | bool | A boolean flag indicating if the account has been blocked |
string | Email address associated with the account | |
name | string | Friendly account name |
parent_account_id | string | The id of the parent account to which this customer belongs |
status | string | Indicates the status of the account. Possible values are: pending , activating , active , deleted |
Responding to Webhooks
Your endpoint must return a 200 OK
HTTP status code.
Otherwise, the callback is considered a failure and retried.