Callback

Developing

POST

/api/v1/connection/callback/{uuid}

Last modified:2026-05-05 15:22:46

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://services.dispatchable.com/docusign/api/v1/connection/callback/' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "event": "recipient-sent",
  "apiVersion": "v2.1",
  "uri": "/restapi/v2.1/accounts/1b652c85-a091-4f2a-bfef-a46860f03798/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e",
  "retryCount": 0,
  "configurationId": 22147135,
  "generatedDateTime": "2026-05-05T14:37:44.2950162Z",
  "data": {
    "accountId": "1b652c85-a091-4f2a-bfef-a46860f03798",
    "userId": "ab943d94-ee2d-4073-996b-46bf49f378fd",
    "envelopeId": "145323d3-f0d4-8667-80d3-4c3d105b050e",
    "recipientId": "2",
    "envelopeSummary": {
      "status": "sent",
      "documentsUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e/documents",
      "recipientsUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e/recipients",
      "attachmentsUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e/attachments",
      "envelopeUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e",
      "emailSubject": "Please review and sign your shipping agreement",
      "emailBlurb": "Hi John, please review and sign the attached shipping agreement so we can continue processing your shipment.",
      "envelopeId": "145323d3-f0d4-8667-80d3-4c3d105b050e",
      "signingLocation": "online",
      "customFieldsUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e/custom_fields",
      "notificationUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e/notification",
      "enableWetSign": "true",
      "allowMarkup": "false",
      "allowReassign": "true",
      "createdDateTime": "2026-05-05T14:37:42.95Z",
      "lastModifiedDateTime": "2026-05-05T14:37:42.95Z",
      "initialSentDateTime": "2026-05-05T14:37:44.297Z",
      "sentDateTime": "2026-05-05T14:37:44.297Z",
      "statusChangedDateTime": "2026-05-05T14:37:44.297Z",
      "documentsCombinedUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e/documents/combined",
      "certificateUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e/documents/certificate",
      "templatesUri": "/envelopes/145323d3-f0d4-8667-80d3-4c3d105b050e/templates",
      "expireEnabled": "true",
      "expireDateTime": "2026-09-02T14:37:44.297Z",
      "expireAfter": "120",
      "sender": {
        "userName": "Colin Dixon",
        "userId": "ab943d94-ee2d-4073-996b-46bf49f378fd",
        "accountId": "1b652c85-a091-4f2a-bfef-a46860f03798",
        "email": "colinroydixon@gmail.com",
        "ipAddress": "173.231.200.125"
      },
      "folders": [
        {
          "name": "Sent Items",
          "type": "sentitems",
          "owner": {
            "userId": "ab943d94-ee2d-4073-996b-46bf49f378fd",
            "email": "colinroydixon@gmail.com"
          },
          "folderId": "058eeef4-6c9c-4ca2-a04c-7802b0676c21",
          "uri": "/folders/058eeef4-6c9c-4ca2-a04c-7802b0676c21"
        },
        {
          "name": "Inbox",
          "type": "inbox",
          "owner": {
            "userId": "ab943d94-ee2d-4073-996b-46bf49f378fd",
            "email": "colinroydixon@gmail.com"
          },
          "folderId": "816f652d-54e9-4487-a06d-914832134595",
          "uri": "/folders/816f652d-54e9-4487-a06d-914832134595"
        },
        {
          "name": "out_for_signature"
        }
      ],
      "customFields": {
        "textCustomFields": [
          {
            "fieldId": "10000000035648661",
            "name": "envelopeTypes",
            "show": "false",
            "required": "true",
            "value": "AgencyAgreements"
          },
          {
            "fieldId": "10000000035648662",
            "name": "templateUsageRestriction",
            "show": "false",
            "required": "false",
            "value": "allOptions"
          },
          {
            "fieldId": "10000000035648663",
            "name": "dispatchable_item_type",
            "show": "false",
            "required": "false",
            "value": "load"
          },
          {
            "fieldId": "10000000035648664",
            "name": "dispatchable_item_uuid",
            "show": "false",
            "required": "false",
            "value": "776d4cef-9e8b-463a-b312-a2634dd06de1"
          },
          {
            "fieldId": "10000000035648665",
            "name": "dispatchable_source",
            "show": "false",
            "required": "false",
            "value": "load_detail_page"
          }
        ],
        "listCustomFields": []
      },
      "recipients": {
        "signers": [
          {
            "offlineAttributes": {
              "offlineSigningHash": "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"
            },
            "creationReason": "sender",
            "canSignOffline": "true",
            "isBulkRecipient": "false",
            "recipientSuppliesTabs": "true",
            "requireUploadSignature": "false",
            "name": "Colin Dixon",
            "email

Response Example

{}

Modified at 2026-05-05 15:22:46

Refresh envelope status from DocuSign

Index