GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
Changelog
These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.
improved

Added unique identifier to webhook event payload

We recently added a unique identifier (uuid) to all webhook event payloads that are POSTed to your application's subscription URL.

We recommend that you leverage this uuid to track the webhook events that you process in your application. You may occasionally receive the same event more than once. In such cases, leveraging uuid in your webhook event handlers will make it easier for you to implement idempotency and ensure that you successfully process a webhook event exactly once.

Here's an example of the new webhook event payload:

{
  "event_type": "company.onboarded",
  "resource_type": "Company",
  "resource_id": 53,
  "resource_uuid": "7779b433-56d4-4729-9fba-7ccbcc2b094e",
  "entity_type": "Company",
  "entity_id": 53,
  "entity_uuid": "7779b433-56d4-4729-9fba-7ccbcc2b094e",
  "timestamp": 1707506458,
  "uuid": "03ffbf0c-48a9-4f1c-932a-546413a26ad1"
}

Note that this uuid is already returned in the API response when you poll our Events API, which fetches all webhook events, going back up to 30 days, that your partner application has the required scopes for.

For more information about webhooks, reference our guide here.