Session Settings
After your users setup their session, you might want to let them reauthenticate, edit, or delete the session.
Additionally, you might want to retrieve the configuration information for the session (what integration provider your users chose, passthrough schemas, passthrough fields, etc.) or information regarding transfer errors or completions.
Reauthenticate Session
In very rare cases, an authentication for a session might expire. This might be because an API key was revoked, or a refresh token was expired (typically, with OAuth credentials Endgrate automatically refreshes them). In these cases, an authentication error will be logged and returned to you. You may want to allow your users to reauthenticate a session, which you can do by redirecting them to the GET /session/reauthenticate endpoint.
Edit Session
If schema_selection
, resource_selection
, or field_selection
was turned on for a session, you may want to allow your users to edit a session. You can do so by redirecting them to the GET /session/edit endpoint.
Delete Session
You can delete an entire session, along with all of its associated data, by hitting the POST api/session/delete endpoint.
Session Configuration
There are two ways to get session configuration information. You can either specify a webhook when initiating your session, or hit the GET api/session/configuration endpoint.
Transfer Errors
There are two ways to get transfer error information. You can either specify a webhook when initiating your session, or hit the GET api/errors endpoint.
Transfer Completion
To get notified when a transfer is complete, specify a webhook when initiating your session.
Updated 6 months ago