# Envelope opened

This webhook is triggered when a recipient opens an envelope. It includes basic information about the envelope, the recipient, and associated documents.


Endpoint: POST opened-envelope
Version: 1.0.0
Security: basicAuth

## Request fields (application/x-www-form-urlencoded):

  - `action` (string, required)
    The action taken. Defaults to .
    Example: "opened-envelope"

  - `action_date` (string, required)
    The UTC timestamp of when the envelope was opened
    Example: "2025-08-07T10:14:26+00:00"

  - `company_id` (integer, required)
    The ID of the company that owns the envelope
    Example: 64034

  - `contact_id` (integer, required)
    The ID of the contact who opened the envelope
    Example: 7418454

  - `contact_name` (string, required)
    The name of the contact who opened the envelope
    Example: "Abby"

  - `contact_email` (string, required)
    The email address of the contact who opened the envelope
    Example: "abby@signable.co.uk"

  - `envelope_fingerprint` (string, required)
    A string identifying the opened envelope
    Example: "584ea8b41b0d4c17a96b967433b211e6"

  - `envelope_documents` (string, required)
    A stringified JSON array of documents in the envelope
    Example: "[{\"document_title\":\"Blank Word Doc\",\"document_fingerprint\":\"584ea8b41b0d4c17a96b967433b211e6\",\"document_pdf\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\",\"document_download\":\"https://api.signableapi.com/shareable/document?t=03cbb315-4f68-400d-a5cc-c2884996d061\"}]"

  - `envelope_download` (string, required)
    A download link for the entire envelope
    Example: "https://api.signableapi.com/shareable/envelope?t=03cbb315-4f68-400d-a5cc-c2884996d061"

  - `envelope_meta` (string)
    A JSON string of any meta information added to the envelope

  - `user_id` (integer, required)
    The ID of the user associated with this event
    Example: 267199

  - `client_ip` (string, required)
    The IP address from which the envelope was opened
    Example: "203.0.113.106"