Sync Completed (syncCompleted)
Sent when a connection sync finishes, whether it succeeded or failed.
Id: syncCompleted
Event that notifies when a synchronisation of a connection has completed, either successfully or with an error.
Payload
These fields are sent in the payload object of the webhook envelope.
| Name | Type | Description |
|---|---|---|
| completedAt | string | The time the synchronisation completed |
| processingStatus | string | The status of the sync: success if it succeeded, error if it failed |
| syncId | string | The ID of the synchronisation that has completed |
| connectionId | string | The ID of the connection the sync event belongs to |
Example (JSON format)
{
"id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
"eventType": "syncCompleted",
"userId": "5c79210bbac25ecb5e71ac40",
"payload": {
"completedAt": "2022-04-12T10:22:40.573Z",
"processingStatus": "success",
"syncId": "7f3ef231-e9bf-4345-af1a-d1e9e727382f",
"connectionId": "1ffe704d39629a929c8e293880fb449a:cb126400-1d69-4242-b188-fc8b5c22783b"
}
}This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.
Related
Updated 5 days ago
