Account status updates
Learn how to handle account status.
Feature available for :LinkedIn, WhatsApp, Instagram, Messenger, Telegram, X (Twitter), Google, Microsoft, IMAP
Unipile's Account Status Webhook is a powerful feature that allows you to monitor the life cycle of an account's status and take actions based on changes in the status. This Webhook provides real-time updates on the synchronization status of your accounts, and on the connection creation.
Synchronization status
Here is an example payload for a synchronization request:
{
"AccountStatus": {
"account_id": "h_EKCy2lRLef5NzHp0iw4A",
"account_type": "LINKEDIN",
"message": "CREDENTIALS"
}
}
Here is the different Synchronization status that can be notified by the Webhook.
Status | Description |
---|---|
OK | Everything seems to be in good order. When the account status is not
|
ERROR /STOPPED | Account synchronization has stopped due to an unexpected error during data fetching. |
CREDENTIALS | Synchronization of accounts has been interrupted due to invalid or missing credentials required for retrieving new data. This situation may arise in several scenarios, including, but not limited to: IMAP::
Email (Google/Microsoft) :
WhatsApp/Telegram:
LinkedIn:
|
CONNECTING | The account is attempting to connect. If your credentials are correct, it may be because the provider is temporarily down, your proxy or a synchronization catch-up. It's temporary status. |
DELETED | You deleted the account |
CREATION_SUCCESS | The account was successfully added and the initial data synchronization has begun. CREATION_SUCCESS can be notified by the Webhook and/or "notify_url" in hosted auth (not with same format). Account can take few seconds to be able to perform requests, you can wait for "OK" status to be sure all is ready. |
RECONNECTED | Account has been reconnected with success. Can be notified by the Webhook and/or "notify_url" in hosted auth (not with same format). |
SYNC_SUCCESS | Only for LinkedIn/IMAP/WhatsApp/Instagram | The account (re)synchronization is finished |
Updated about 20 hours ago