This type of callback URL is set up at the API app level. API apps are used to identify a partner integration and configure embedded flows (embedded signign, embedded requesting, and embedded templates) and OAuth providers
All events that involve signature requests created by an API app are reported to this URL. The event will include a client_id
field to indicate which app the event is being reported for, which allows multiple API apps to share the same callback URL.
You can manage your apps and their callbacks from the settings page.
API App Callback Payloads --
Events that are reported at the API App level through the Event callback URL defined in your API settings for a specific app. The Event callback URL can also be updated by calling Update API App and passing a callback_url
.
required | object (EventCallbackRequestEvent) Basic information about the event that occurred. |
object (AccountResponse) | |
object (SignatureRequestResponse) Contains information about a signature request. | |
object (TemplateResponse) Contains information about the templates you and your team have created. |
successful operation
{ "event": { "event_time": "1348177752", "event_type": "account_confirmed", "event_hash": "3a31324d1919d7cdc849ff407adf38fc01e01107d9400b028ff8c892469ca947", "event_metadata": { "related_signature_id": null, "reported_for_account_id": null, "reported_for_app_id": "5b6eac0ac5f82db0cf5f394ce4f6b150" } }, "account": { "account_id": "5008b25c7f67153e57d5a357b1687968068fb465", "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": true, "is_paid_hf": false, "quotas": { "api_signature_requests_left": 1250, "documents_left": null, "templates_left": null }, "callback_url": null, "role_code": null } }