Skip to content

Event Callback signature_request_canceled does not return metadata in event data #478

@dkwong

Description

@dkwong

The signature_request_canceled event callback does not seem to include any information other than the signature_request_id. In particular, returning the metadata field that was passed in the signature request would be extremely helpful.
Was this an intentional decision to not include any data in the callback?

Example response after making a signature request:

{
  "signature_request": {
    "signature_request_id": "example_id_123",
    "test_mode": true,
    "title": "Signature Request",
    "original_title": "Signature Request",
    "subject": "Signature Request",
    "message": "Please review and sign the following document",
    "metadata": {
         "myId": "id12345"
    },
    ...
  }
}

Example return of a signature_request_canceled callback

{
  "signature_request": {
    "test_mode": true,
    "signature_request_id": "example_id_123",
    "title": "",
    "original_title": "",
    "metadata": {},
    "created_at": 0,
    "is_complete": false,
    "is_declined": false,
    "has_error": false,
    "files_url": "",
    "cc_email_addresses": [],
    "template_ids": [],
    "custom_fields": [],
    "attachments": [],
    "response_data": [],
    "signatures": []
  },
  "event": {
    ...
  }
  ...
}

in this case: myId is not returned in the callback in the metadata field.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions