--- title: "Get callback info by ID" method: GET path: "/v2/event-subscriptions/{subscription_id}/callbacks/{callback_id}" --- # Get callback info by ID `GET /v2/event-subscriptions/{subscription_id}/callbacks/{callback_id}` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/v2/event-subscriptions/{subscription_id}/callbacks/{callback_id}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint allows API users to get detailed info about one webhook by its ID. ## Response `200` Depending on the type of event, the `initiator_id` parameter can be placed differently in response body (into the `request_content` object): * only in the `meta` object if `event_name` is: * `document.update` * `document.complete` * `document.open` * `template.copy` * `document.fieldinvite.create` etc. * `document_group.update` * `document_group.invite.create` etc.; * in the `meta` and in the `content` objects if `event_name` is: * `document.delete` * `document_group.delete` * `document_group.open` * `user.document_group.open` * `document_group.invite.declined` * `user.document_group.invite.declined` * `document_group.complete` * `user.document_group.complete` The type of event also affects the composition of the parameters of the `request_content` object.
See the callback payload for each event
Event "request_content" object
document.delete
user.document.delete 		```json { "meta": { "timestamp": 1748521868, "event": "document.delete", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}", "access_token": "********", "metadata": [] }, "content": { "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "document_name": "Sample Document", "user_id": "b2e8364f412c04037bee10a8db9201a727551443", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "initiator_email": "signer@example.com" } } ```
document.update
user.document.update
user.document.create
user.document.complete
document.complete 		```json { "meta": { "timestamp": 1748521868, "event": "document.update", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}", "access_token": "********", "metadata": [] }, "content": { "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "document_name": "Sample Document", "user_id": "b2e8364f412c04037bee10a8db9201a727551443" } } ```
document.open
user.document.open 		```json { "meta": { "timestamp": 1748521868, "event": "document.open", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}", "access_token": "********", "metadata": [] }, "content": { "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "document_name": "Sample Document", "user_id": "b2e8364f412c04037bee10a8db9201a727551443", "viewer_user_unique_id": "12b5d12203a916fa07f5b13c362140efebdbce5f" } } ```
template.copy
user.template.copy 		```json { "meta": { "timestamp": 1748521868, "event": "template.copy", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}", "access_token": "********", "metadata": [] }, "content": { "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "template_id": "c70050bfdf4c4d8187783deaac304cb7cbe450b5", "user_id": "b2e8364f412c04037bee10a8db9201a727551443", "viewer_user_unique_id": "12b5d12203a916fa07f5b13c362140efebdbce5f" } } ```
user.document.fieldinvite.create
user.document.fieldinvite.decline
user.document.fieldinvite.delete
user.document.fieldinvite.signed
user.document.fieldinvite.sent
user.document.freeform.create
user.document.freeform.signed
document.fieldinvite.create
document.fieldinvite.decline
document.fieldinvite.delete
document.fieldinvite.signed
document.fieldinvite.sent
document.freeform.create
document.freeform.signed 		```json { "meta": { "timestamp": 1748521868, "event": "document.fieldinvite.create", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}", "access_token": "********", "metadata": [] }, "content": { "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "invite_id": "e575c611b641ea7694c6fa3acf3b2fa6dba14287", "signer": "signer@example.com", "status": "pending" } } ```
user.document.fieldinvite.reassign
document.fieldinvite.reassign 		```json { "meta": { "timestamp": 1748521868, "event": "document.fieldinvite.reassign", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}", "access_token": "********", "metadata": [] }, "content": { "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "invite_id": "e575c611b641ea7694c6fa3acf3b2fa6dba14287", "signer": "signer@example.com", "old_invite_unique_id": "a3c84d21c3631347f854510d6facb30129f9bc06" } } ```
user.document.fieldinvite.replace
document.fieldinvite.replace 		```json { "meta": { "timestamp": 1748521868, "event": "document.fieldinvite.replace", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}", "access_token": "********", "metadata": [] }, "content": { "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "invite_id": "e575c611b641ea7694c6fa3acf3b2fa6dba14287", "signer": "signer@example.com", "old_invite_unique_id": "a3c84d21c3631347f854510d6facb30129f9bc06", "group_invite": true } } ```
user.document_group.create
user.document_group.update
document_group.update 		```json { "meta": { "timestamp": 1748521868, "event": "document_group.update", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}", "access_token": "********", "metadata": [] }, "content": { "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3", "group_name": "Sample Document Group", "user_id": "b2e8364f412c04037bee10a8db9201a727551443" } } ```
user.document_group.complete
document_group.complete 		```json { "meta": { "timestamp": 1748521868, "event": "document_group.complete", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}", "access_token": "********", "metadata": [] }, "content": { "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3", "group_name": "Sample Document Group", "user_id": "b2e8364f412c04037bee10a8db9201a727551443", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "initiator_email": "signer@example.com", "completed_at": 1748521868, "documents": [ { "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "document_name": "Sample Document", "status": "completed" } ], "invite_steps": [ { "order": 1, "status": "completed", "signers": [ { "email": "signer@example.com", "role_name": "Signer 1", "action": "sign", "status": "fulfilled", "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a", "signed_at": 1748521800 } ] } ] } } ```
document_group.delete
user.document_group.delete 		```json { "meta": { "timestamp": 1748521868, "event": "document_group.delete", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}", "access_token": "********", "metadata": [] }, "content": { "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3", "group_name": "Sample Document Group", "user_id": "b2e8364f412c04037bee10a8db9201a727551443", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "initiator_email": "signer@example.com" } } ```
document_group.open
user.document_group.open 		```json { "meta": { "timestamp": 1748521868, "event": "document_group.open", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}", "access_token": "********", "metadata": [] }, "content": { "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3", "group_name": "Sample Document Group", "user_id": "b2e8364f412c04037bee10a8db9201a727551443", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "initiator_email": "signer@example.com" } } ```
user.document_group.invite.create
user.document_group.invite.resend
user.document_group.invite.update
user.document_group.invite.cancel
document_group.invite.create
document_group.invite.resend
document_group.invite.update
document_group.invite.cancel 		```json { "meta": { "timestamp": 1748521868, "event": "document_group.invite.create", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}", "access_token": "********", "metadata": [] }, "content": { "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3", "group_invite_id": "d4d02074b369b58f303aebc46680b161419072d1", "status": "pending" } } ```
document_group.invite.declined
user.document_group.invite.declined 		```json { "meta": { "timestamp": 1748521868, "event": "document_group.invite.declined", "environment": "https://api.signnow.com", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}", "access_token": "********", "metadata": [] }, "content": { "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3", "group_invite_id": "d4d02074b369b58f303aebc46680b161419072d1", "status": "canceled", "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423", "initiator_email": "signer@example.com" } } ``` > **Note:** For SMS invitees, `initiator_email` contains a system-generated address in the format `sms_signer_{phone_number}@no.reply`.
user.document_group.invite.expired ```json { "meta": { "timestamp": 1748521868, "event": "user.document_group.invite.expired", "environment": "https://api.signnow.com", "initiator_id": null, "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}", "access_token": "********", "metadata": [] }, "content": { "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3", "group_name": "Sample Document Group", "group_invite_id": "d4d02074b369b58f303aebc46680b161419072d1", "step": 2, "signers": [ "signer@example.com", "signer2@example.com" ] } } ```

`Param` will be added to `callback_url` parameter, if `docid_queryparam` is `true`: ``` "callback_url":"{{callback_url}}?Param={\"groupId\":\"{{document_unique_id}}\"} ``` See [`docid_queryparam`](/docs/manage-event-subscriptions/operations/create-event-subscription-2) details `access_token` will be added only if `delete_access_token` will be `false`.
See [`delete_access_token`](/docs/manage-event-subscriptions/operations/create-event-subscription-2) details. - object - `data` object: Details of the callback. - `id` string: Unique ID of the callback record. - `duration` number: Duration of the callback request in seconds. - `entity_id` string: ID of the entity (document, document group, or template) that triggered the event. - `event_name` string: Name of the triggered event (for example, `document.delete`). - `entity_type` string: Type of entity. Possible values: `user`, `document`, `document_group`. - `callback_url` string: URL to which the webhook payload was sent. - `request_method` string: HTTP method used for the callback request. Always `post`. - `request_content` object: Full payload sent to the callback URL. - `meta` object: Metadata of the event. - `event` string: Name of the triggered event. - `metadata` object[]: Custom metadata attached to the entity at the time the event was triggered. - `timestamp` integer: Unix timestamp of when the event occurred. - `environment` string: API environment URL. - `access_token` string: Bearer access token. Present only if `delete_access_token` is `false`. - `callback_url` string: Callback URL, including any `docid_queryparam` query parameters if configured. - `initiator_id` string: ID of the user who triggered the event. - `content` object: Event-specific payload. The fields vary depending on the event type. The parameters listed here correspond to the `document_group.invite.declined` and `user.document_group.invite.declined` events. See the response description for per-event payload examples. - `status` string: Status of the invite. - `user_id` string: ID of the user who triggered the event. - `group_id` string: ID of the document group. - `step_order` integer: Step of the invite the event relates to. - `document_id` string: ID of the document the event relates to. - `initiator_id` string: ID of the user who triggered the event. - `document_name` string: Name of the document the event relates to. - `group_invite_id` string: ID of the document group invite. - `initiator_email` string: Email of the user who triggered the event. For SMS invitees, this is a system-generated address in the format `sms_signer_{phone_number}@no.reply`. - `request_headers` object: Headers sent with the callback, as key-value pairs. An empty array if there are none. - `application_name` string: Name of the application that owns the subscription. - `request_end_time` integer: Unix timestamp of when the request completed. - `response_content` string: Response body returned by the callback URL. - `request_start_time` integer: Unix timestamp of when the request was initiated. - `response_status_code` integer: HTTP status code returned by the callback URL. - `event_subscription_id` string: ID of the event subscription that triggered this callback. - `event_subscription_active` boolean: Indicates whether the event subscription is currently active. - `event_subscription_owner_email` string: Email of the user who owns the event subscription. ## Other responses - `400`: * Wrong, expired, or missing token. * Request with valid bearer token but application deactivated/deleted. * Request authenticated with Basic token. - `403`: Request with token of another application. - `404`: * The event subscription doesn't exist. * The callback doesn't exist. --- [API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)