Payloads
Each event type has a specific payload format containing the relevant event information.
Delivery Headers
The webhook events will send HTTP requests to your endpoint(s) containing several headers (this is a non-exhaustive list):
Header | Description | Example |
---|---|---|
content-length | Length of the content that is sent. | "210" |
content-type | The type of the raw data. | "application/json" |
x-workbright-event-account | The subdomain of the account that sent the webhook. | "initech" |
x-workbright-event | The specific event key associated with the webhook. Note: use this or the event_key from the JSON body to differentiate between events as necessary. | "employee.form_submitted" |
x-workbright-event-description | A human-readable description of the event. Note: this should be used for display purposes only due to inconsistent formatting. | "Employee Submitted a Form" |
authorization | The type of authorization, if a login is created during setup. | "Basic YTpi62hed2" |
php-auth-user | The authorization username, if a login is created during setup. | "JDoe" |
php-auth-pw | The authorization password, if a login is created during setup. | "TestPass12" |
In addition to the above headers, the payload will contain the following JSON body:
{
"event_key": "employee.form_submitted",
"occurred_at": "2015-12-08T11:32:39.398-07:00",
"data": {
// Event-specific data
}
}
Updated 4 months ago