All webhook payloads are JSON data sent via POST and conform to the following format:
object_type
- The type of Object that triggered the webhook, such as Job, Invoice, etcevent
- The event that triggered the webhook, always created
or updated
object
- The current representation of the object in Latchelupdated
List of properties that were updated, and what their new values are (for the updated
event type only)Our documentation below will omit this payload information, because it is the same for all webhooks. The webhooks below will simply include the object payload that will be included with each webhook request.
Webhook bodies include a property named secret, and the header includes a property called x-api-key
. Both the secret value and the x-api-key header contain a UUID that is unique to your account. Please contact Latchel Engineering to obtain your UUID codes for production and staging environments.
The platform property is always LATCHEL
. This is available for partners who wish to use one endpoint to receive data from multiple platforms.
An updated
webhook will be triggered when one or more of the properties listed in the object’s schema is changed. For convenience, the updated
property of the webhook payload will contain which of the object’s properties have changed, and what the new values are.
It should be noted that changes to related records will not trigger an object’s webhook. Examples:
job.description
has changed)job.vendor_id
will change)All webhook payloads are JSON data sent via POST and conform to the following format:
object_type
- The type of Object that triggered the webhook, such as Job, Invoice, etcevent
- The event that triggered the webhook, always created
or updated
object
- The current representation of the object in Latchelupdated
List of properties that were updated, and what their new values are (for the updated
event type only)Our documentation below will omit this payload information, because it is the same for all webhooks. The webhooks below will simply include the object payload that will be included with each webhook request.
Webhook bodies include a property named secret, and the header includes a property called x-api-key
. Both the secret value and the x-api-key header contain a UUID that is unique to your account. Please contact Latchel Engineering to obtain your UUID codes for production and staging environments.
The platform property is always LATCHEL
. This is available for partners who wish to use one endpoint to receive data from multiple platforms.
An updated
webhook will be triggered when one or more of the properties listed in the object’s schema is changed. For convenience, the updated
property of the webhook payload will contain which of the object’s properties have changed, and what the new values are.
It should be noted that changes to related records will not trigger an object’s webhook. Examples:
job.description
has changed)job.vendor_id
will change)