These docs are for v2.1. Click to read the latest docs for v3.

rs.initiated

A new signature request was initiated

This event is fired when a new signature requested is initiated by your users. The payload will contain the details of the signers, document and the order of signing thereby helping you update any workflows on your end. It can also contain user specific metadata(request_info) if it was sent during RS creation.

{
  "data": {
    "owner_email": "[email protected]",
    "sources": [
      {
        "type": "original",
        "id": 5000000,
        "name": "ESOP GRANT LETTER"
      }
    ],
    "team_id": null,
    "expiry_time": 1683033398,
    "last_modified_time": 1650867458,
    "message": "ESOP Letter - John",
    "subject": null,
    "owner_first_name": "Jane",
    "id": 3000000,
    "is_envelope": "1",
    "owner_last_name": "",
    "next": 6000000,
    "status": "incomplete",
    "recipients": [
      {
        "status": "not_viewed",
        "phone_number": "",
        "first_name": "John",
        "last_name": "Doe",
        "order_id": 1,
        "created_time": 1650867457,
        "recipient_user_id": 5112872,
        "recipient_id": 6303052,
        "last_modified_time": 1650867457,
        "email": "[email protected]"
      }
    ],
    "is_ordered": 0,
    "has_markers": 1,
    "owner_user_id": 8000000,
    "name": "ESOP GRANT LETTER.pdf",
    "created_time": 1650867454
  },
  "metadata": {
    "event_type": "rs.initiated",
    "token": null,
    "event_user_id": "8000000",
    "client_id": null,
    "event_user": "[email protected]"
  }
}