Event Callback
You can setup a webhook-like function in your Pathfix application that would notify you on your connected user's connection status. You can add any listening url from your app to the setup that will be called when the following events occur with your user connection:
- USER_CONSENT_SUCCESS
- USER_CONSENT_FAILURE
- USER_CONSENT_DISCONNECT
- CALL_FORMAT_ERROR
- API_ERROR
- INVALID_OAUTHID
To setup the callback event:
- Log in to your Pathfix OAuth account
- Locate the Application for which you want to enable this for and click on Edit
- Click on the Event Callback tab
- Enter the callback url to be called for the event and hit Save
Here is a breakdown on what each of the events mean:
Event Type | Description |
|---|---|
USER_CONSENT_SUCCESS | When a user connection is successful made i.e. a user has successfully connected his provider account to your application |
USER_CONSENT_FAILURE | When a user connection has failed i.e. the oauth connection to the users account has failed |
USER_CONSENT_DISCONNECT | When a user has disconnected their account |
CALL_FORMAT_ERROR | There is an error in the API call format e.g. malformed JSON. |
API_ERROR | The provider has returned an error in the API. Check the API structure as specified by the provider and try again |
INVALID_OAUTHID | When an API call is attempted before a user has authenticated your app i.e. user does not have a valid oauth connection |
Need help? Reach out to us at [email protected] and we would be happy to assist!
