Sync Complete Webhook

This webhook triggers when a scheduled (READ) sync completes.

Why use SYNC_COMPLETE webhooks?

Oftentimes, customers want to be able to react knowing that they have the most recent copy of any given data from a PMS. This webhook will allow you to be alerted as soon as one of your syncs has finished, regardless of the runtime or PMS.

Webhook Payload

The payload for the SYNC_COMPLETE webhook looks like the following:

1
{
2
    "integration_id": string,
3
    "successful_job_count": integer,
4
    "failed_job_count": integer,
5
    "is_sync_finished": boolean,
6
    "vendor": IntegrationVendorEnum
7
}

In this payload, you’re provided with the ID of the integration associated with this completed sync, the number of successful jobs ran, the number of failed jobs ran, and whether the sync has been completed or not.

The reason we include is_sync_finished here is in the case of a prolonged PMS outage or any situation where a sync would run for a significant amount of time (upwards of 12 hours) and not complete. This is an unexpected case and should not occur except for exceptional cases.

Due to the complexities of PMS retries, we include the number of successful jobs and failed jobs in case you want to be alerted of increased failures for a given sync. Some number of failed jobs is normal for a sync, as network blips or load on the PMS is encountered. This will automatically be retried by our system. If you notice a significant increase in failed jobs, there may be cause to check for expired credential access or other related issues.

Example use cases

Alerts for completed new customer syncs

If you create new integrations for your users via our API, this webhook gives you a quick way to be alerted as to when their initial data import has been completed. With this, you may want to alert them to a successful onboarding or reveal an appropriate UI to them.

Periodic System Syncs

On reception of this webhook, you know that Propexo has finished querying all new data for your PMS. This may be a great way to know that you can begin querying our API to get the freshest data related to an integration.

In this case, though, we’d also like to mention the DATA_NEW and DATA_UPDATE webhooks as a potential solution as well.

The FIRST_SYNC_COMPLETE Webhook

We also offer a variant of the SYNC_COMPLETE webhook called FIRST_SYNC_COMPLETE which will only send webhooks on the completion of the first sync for an job schedule on an integration. This can be handy if you’re onboarding your customers and creating their integrations via our API. If subscribed to FIRST_SYNC_COMPLETE webhooks you’ll receive a specific event that will only trigger on the completion of their first full data sync.

The common use case we’ve seen for this is when you want to be able to ingest your customer’s data from Propexo as soon as you can to give your customers the most complete experience possible.