{
  "openapi": "3.1.0",
  "info": {
    "title": "SignatureAPI: Webhooks",
    "summary": "SignatureAPI is an API-first electronic signature platform.",
    "version": "1.18.0",
    "description": "SignatureAPI is a REST API for sending documents for electronic signature. It accepts JSON request bodies, returns JSON responses, and uses standard HTTP verbs and status codes.\n\n### Key concepts\n\nAn **envelope** is the central object. It holds documents and recipients, and manages the signing process from start to finish.\n\nA **document** is a PDF or DOCX file within an envelope. Documents contain **places** — interactive fields like signatures, initials, text inputs, checkboxes, and dropdowns positioned at specific locations.\n\nA **recipient** is a person who receives an envelope. There are three types:\n- **Signer** — signs documents\n- **Approver** — reviews and approves without signing\n- **Preparer** — fills in fields before the signer receives the documents\n\nA **ceremony** is the interactive session where a recipient authenticates and performs their actions. SignatureAPI supports three authentication methods: email link, email code, and custom.\n\nA **deliverable** is the final output — a signed PDF with an audit trail, generated after all recipients complete their actions.\n\nA **sender** is a verified email address that SignatureAPI sends signing requests on behalf of.\n\nAn **upload** is a file stored in SignatureAPI for use as a document source in envelopes.\n\n### HTTP Semantics\n\nWe use HTTP verbs GET, POST, DELETE as defined in RFC 9110, and PATCH as defined in RFC 5789.\n\nWe use the following HTTP Status codes for successful responses:\n\n- **200 OK**: Request succeeded for a GET, POST, or PATCH call.\n- **201 Created**: Request succeeded for a POST request that created a new resource. The response includes a Location header pointing to the newly created resource.\n\n### Versioning\n\nWe use [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html):\n\n- We increment Major (the X in X.Y.Z) versions when we make a change that breaks backward compatibility. The current major version is 1.\n- We increment Minor (the Y in X.Y.Z) versions when we add backward compatible features.\n- We increment Patch (the Z in X.Y.Z) versions when we make backward compatible bug fixes or improvements in the documentation.\n\nSignatureAPI considers the following changes to break backward compatibility:\n\n- Removing or renaming fields, arguments, or enum values.\n- Removing endpoints.\n- Changing the type of fields in the response (for example, from string to integer).\n- Adding a new **required** request parameter.\n\nThese are not breaking changes:\n\n- Any additive change, such as adding endpoints, optional arguments, fields, or enum values.\n- Making a required request parameter optional.\n- Making a validation less restrictive.\n- Changes to error responses. _We do not recommend parsing error responses to perform business logic._\n- Changes to the order of fields returned in a response.\n- Changes to the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings.\n- Adding new event types.\n- Changes in the structure and descriptions in this OpenAPI spec.",
    "contact": {
      "name": "Signature API, Inc.",
      "email": "support@signatureapi.com"
    },
    "termsOfService": "https://signatureapi.com/terms"
  },
  "servers": [
    {
      "description": "SignatureAPI Global Server.",
      "url": "https://api.signatureapi.com/v1"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Webhooks"
    }
  ],
  "paths": {},
  "webhooks": {
    "envelope.created": {
      "post": {
        "operationId": "envelope.created",
        "summary": "Envelope created event",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when a new envelope is created. The envelope is in `processing` status at this point and has not yet been sent to recipients.\n\nUse this event to record that a signing process has been initiated in your system.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.EnvelopeCreated"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "envelope.created",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "envelope",
                  "object_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "envelope.started": {
      "post": {
        "operationId": "envelope.started",
        "summary": "Envelope Started Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when an envelope transitions from `processing` to `in_progress`. At this point, the envelope has been prepared and recipients are being notified.\n\nFor sequential routing, the first recipient receives the signing request. For parallel routing, all recipients receive it at the same time.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.EnvelopeStarted"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "envelope.started",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "envelope",
                  "object_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "envelope.completed": {
      "post": {
        "operationId": "envelope.completed",
        "summary": "Envelope Completed Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when all recipients have completed their part and the envelope transitions to `completed` status. The deliverable with the signed documents may still be generating when this event is sent.\n\nUse this event to update records or notify your team. To retrieve or store the signed documents, listen for `deliverable.generated` instead.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.EnvelopeCompleted"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "envelope.completed",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "envelope",
                  "object_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "envelope.failed": {
      "post": {
        "operationId": "envelope.failed",
        "summary": "Envelope Failed Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when an envelope encounters an internal error and transitions to `failed` status. The event payload includes a `detail` field with a human-readable explanation of the failure.\n\nEnvelope failures are very rare and automatically trigger an alert to the SignatureAPI team. No action is typically required on your part.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.EnvelopeFailed"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "envelope.failed",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "envelope",
                  "object_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "detail": "Error processing envelope for recipient at index: 1",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "envelope.canceled": {
      "post": {
        "operationId": "envelope.canceled",
        "summary": "Envelope Canceled Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when an envelope is canceled via the Cancel Envelope endpoint. The envelope transitions to `canceled` status and all signing activity stops permanently.\n\nThe event payload includes an optional `reason` field if one was provided when the envelope was canceled.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.EnvelopeCanceled"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "envelope.canceled",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "envelope",
                  "object_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "reason": "Not ready to sign",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.released": {
      "post": {
        "operationId": "recipient.released",
        "summary": "Recipient Released Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when a recipient becomes ready to receive an invitation. The recipient's status changes to `pending`.\n\nThis happens after all previous recipients in the routing order have completed, or immediately for the first recipient when the envelope starts processing.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientReleased"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.released",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.sent": {
      "post": {
        "operationId": "recipient.sent",
        "summary": "Recipient Sent Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when the invitation email is sent to a recipient. The recipient's status changes to `sent`.\n\nThis event only fires for recipients whose ceremony uses `email_link` authentication, because that is the only case where SignatureAPI sends the invitation email.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientSent"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.sent",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.accessed": {
      "post": {
        "operationId": "recipient.accessed",
        "summary": "Recipient Accessed Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when a recipient opens the ceremony URL. Includes the recipient's `ip` address, `user_agent`, and `session_id`.\n\nTo reduce duplicate events, this fires at most once every 60 seconds for the same IP address and user agent combination. The recipient has not yet authenticated at this point.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientAccessed"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.accessed",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "ip": "123.122.990.22",
                  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
                  "session_id": "ses_2X6eHBCL84MDGrLQX0mHI72",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.viewed": {
      "post": {
        "operationId": "recipient.viewed",
        "summary": "Recipient Viewed Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when a recipient has authenticated and the documents are displayed in the ceremony. This confirms the recipient has passed any authentication steps and can now view the documents.\n\nIncludes a `session_id` to correlate with other events in the same ceremony session.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientViewed"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.viewed",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "session_id": "ses_2X6eHBCL84MDGrLQX0mHI72",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.completed": {
      "post": {
        "operationId": "recipient.completed",
        "summary": "Recipient Completed Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when a recipient finishes all required actions in the ceremony. The recipient's status changes to `completed`.\n\nFor signers, this means they have signed and finalized. For approvers and preparers, this means they have reviewed and submitted their inputs. Includes a `session_id` to correlate with other events in the same ceremony session.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientCompleted"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.completed",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "session_id": "ses_2X6eHBCL84MDGrLQX0mHI72",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.rejected": {
      "post": {
        "operationId": "recipient.rejected",
        "summary": "Recipient Rejected Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when a recipient declines to complete the envelope. The recipient's status changes to `rejected`.\n\nThe `reason` field contains the explanation the recipient provided, if any. A rejection does not cancel the envelope. To move on, either replace the recipient or cancel the envelope, through the API or the Dashboard. Includes a `session_id` to correlate with other events in the same ceremony session.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientRejected"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.rejected",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "reason": "Not the terms we agreed to on June",
                  "session_id": "ses_2X6eHBCL84MDGrLQX0mHI72",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.soft_bounced": {
      "post": {
        "operationId": "recipient.soft_bounced",
        "summary": "Recipient Soft Bounced Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when the invitation email is temporarily undeliverable. The recipient's status changes to `soft_bounced`.\n\nCommon causes include a full mailbox or a temporary server issue. The `detail` field contains the bounce reason from the remote email server. You can use the Resend Request endpoint to try again.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientSoftBounced"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.soft_bounced",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "detail": "Server 123.122.990.22 responded with: Mailbox Full",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.hard_bounced": {
      "post": {
        "operationId": "recipient.hard_bounced",
        "summary": "Recipient Hard Bounced Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when the invitation email is permanently undeliverable. The recipient's status changes to `hard_bounced`.\n\nCommon causes include an invalid or nonexistent email address. The `detail` field contains the bounce reason from the remote email server. You cannot resend to this recipient. Use the Replace Recipient endpoint to assign a new person.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientHardBounced"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.hard_bounced",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "detail": "Server 123.122.990.22 responded with: Mailbox Full",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.failed": {
      "post": {
        "operationId": "recipient.failed",
        "summary": "Recipient Failed Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when an error prevents the invitation from being sent to a recipient. The recipient's status changes to `failed`.\n\nThe `detail` field contains a description of the failure, such as the recipient's email being on a blocklist. You may need to use the Replace Recipient endpoint to assign a different person.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientFailed"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.failed",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "detail": "Recipient in email blocklist",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.replaced": {
      "post": {
        "operationId": "recipient.replaced",
        "summary": "Recipient Replaced Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when a recipient is replaced with a new person via the Replace Recipient endpoint. The original recipient's status changes to `replaced`.\n\nThe event includes `new_recipient_id` and `new_recipient_name` identifying the replacement recipient.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientReplaced"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.replaced",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "new_recipient_id": "re_5SfFjI3eVfDokAXXDSjJlz",
                  "new_recipient_name": "John Doe",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "recipient.resent": {
      "post": {
        "operationId": "recipient.resent",
        "summary": "Recipient Resent Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when an invitation email is resent to a recipient via the Resend Request endpoint. The recipient's status remains `sent`.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.RecipientResent"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "recipient.resent",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "recipient",
                  "object_id": "re_7vWMHIEuIIit8IRuKgtb61",
                  "recipient_type": "signer",
                  "recipient_key": "tenant",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "deliverable.generated": {
      "post": {
        "operationId": "deliverable.generated",
        "summary": "Deliverable generation success event",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when a deliverable is successfully generated and ready for download. The event payload includes a `url` field with a pre-signed download link.\n\nThis URL expires after 1 hour. If it has expired, retrieve a fresh URL by calling the Get Deliverable endpoint.\n\nUse this event to download and store signed documents in your system automatically.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.DeliverableGenerated"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "deliverable.generated",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "object_type": "deliverable",
                  "object_id": "del_4TpbrIB7ZB2ZNarCJQ8QYR",
                  "deliverable_type": "standard",
                  "deliverable_name": "hr_pack",
                  "included_documents": [
                    "contract",
                    "byod_policy"
                  ],
                  "url": "https://www.example.com/repository/audit-log.pdf",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "deliverable.failed": {
      "post": {
        "operationId": "deliverable.failed",
        "summary": "Deliverable generation failure event",
        "tags": [
          "Webhooks"
        ],
        "description": "Fired when deliverable generation fails. The deliverable status is set to `failed`. The event payload includes a `detail` field with a human-readable explanation of the failure.\n\nThis is a rare event. Support is notified automatically when it occurs.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.DeliverableFailed"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "deliverable.failed",
                "timestamp": "2022-01-01T00:00:00Z",
                "data": {
                  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
                  "deliverable_type": "standard",
                  "deliverable_name": "hr_pack",
                  "included_documents": [
                    "contract",
                    "byod_policy"
                  ],
                  "object_type": "deliverable",
                  "object_id": "del_4TpbrIB7ZB2ZNarCJQ8QYR",
                  "detail": "Recipient in email blocklist.",
                  "envelope_metadata": {
                    "IntegrationId": "123456",
                    "IntegrationName": "My Integration"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "sender.created": {
      "post": {
        "operationId": "sender.created",
        "summary": "Sender created event",
        "tags": [
          "Webhooks"
        ],
        "description": "Triggered when a new sender is created and the verification email is sent. The sender starts in `pending_verification` status. Listen for `sender.verified` or `sender.failed` to track the verification outcome.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.SenderCreated"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "sender.created",
                "timestamp": "2025-01-01T00:00:00Z",
                "data": {
                  "object_type": "sender",
                  "object_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                  "email": "john@example.com"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "sender.verified": {
      "post": {
        "operationId": "sender.verified",
        "summary": "Sender verified event",
        "tags": [
          "Webhooks"
        ],
        "description": "Triggered when a sender completes email verification. The sender status is now `verified` and SignatureAPI can send signing requests on behalf of this email address.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.SenderVerified"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "sender.verified",
                "timestamp": "2025-01-01T00:00:00Z",
                "data": {
                  "object_type": "sender",
                  "object_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                  "email": "john@example.com"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "sender.failed": {
      "post": {
        "operationId": "sender.failed",
        "summary": "Sender failed event",
        "tags": [
          "Webhooks"
        ],
        "description": "Triggered when sender email verification fails. This can happen due to a soft or hard bounce of the verification email, or because of an internal error. The `data.detail` field explains the reason for the failure.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.SenderFailed"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "sender.failed",
                "timestamp": "2025-01-01T00:00:00Z",
                "data": {
                  "object_type": "sender",
                  "object_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                  "email": "john@example.com",
                  "detail": "Verification email bounced"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    },
    "sender.deleted": {
      "post": {
        "operationId": "sender.deleted",
        "summary": "Sender deleted event",
        "tags": [
          "Webhooks"
        ],
        "description": "Triggered when a sender is deleted. SignatureAPI can no longer send signing requests on behalf of this email address.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Event.SenderDeleted"
              },
              "example": {
                "id": "evt_yA80uuM4c90EbmxFuOC8Xv5",
                "type": "sender.deleted",
                "timestamp": "2025-01-01T00:00:00Z",
                "data": {
                  "object_type": "sender",
                  "object_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                  "email": "john@example.com"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Acknowledgment of receipt"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Authentication to the API is performed via an API key in the `X-API-Key` header.\n\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n"
      }
    },
    "schemas": {
      "Envelope.Id": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "format": "uuid",
        "title": "Envelope Id",
        "description": "The unique identifier of the envelope, in UUID format.",
        "examples": [
          "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13"
        ]
      },
      "Envelope.Metadata": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "type": "object",
        "title": "Envelope Metadata",
        "description": "Set of key-value pairs to store additional information about the envelope. Use metadata to attach internal reference IDs, tracking numbers, or other data that connects envelopes to your systems.\n\nMetadata is included in all API responses and webhook payloads (in the `data.envelope_metadata` field), making it useful for correlating events with your records.\n\nUp to 10 keys are allowed. Keys can be up to 32 characters (letters, digits, and underscores). Values can be up to 1,000 characters.\n\nUse metadata only for ordinary business identifiers that are appropriate to store with an envelope.\n",
        "unevaluatedProperties": false,
        "maxProperties": 10,
        "default": {},
        "additionalProperties": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1000
        },
        "propertyNames": {
          "type": "string",
          "pattern": "^[a-zA-Z0-9_]*$",
          "minLength": 1,
          "maxLength": 32
        },
        "example": {
          "caseNumber": "AB5555510",
          "customer_name": "Doe Industries, LLC"
        }
      },
      "Document.Key": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "title": "Document Key",
        "description": "A user-provided identifier for this document within the envelope. Must be unique within the envelope. Use the key to reference this document in other parts of the API.\n\nOnly lowercase letters, numbers, and underscores are allowed. Must start with a letter.\n\nIf not provided, a key is generated automatically.",
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$",
        "minLength": 1,
        "maxLength": 32,
        "examples": [
          "agreement",
          "byod_policy"
        ]
      },
      "Recipient.Key": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "title": "Recipient Key",
        "description": "A user-provided key that identifies a recipient within an envelope. Use the key to reference this recipient when assigning document places.\n\nThe key must start with a lowercase letter and can contain lowercase letters, numbers, and underscores. Maximum 32 characters.\n",
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$",
        "minLength": 1,
        "maxLength": 32,
        "examples": [
          "explorer"
        ]
      },
      "Recipient.Id": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "title": "Recipient Id",
        "description": "The unique identifier of the recipient. Recipient IDs use the `re_` prefix.\n",
        "type": "string",
        "examples": [
          "re_MDGrLQX02X6eHBCL84mHI72"
        ]
      },
      "Recipient.Type": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "title": "Recipient Type",
        "description": "The type of the recipient. Determines what actions the recipient can perform during the ceremony.\n\n| Type | Description |\n|------|-------------|\n| `signer` | Signs documents. Every envelope must have at least one signing recipient. |\n| `qualified_signer` | Signs with a qualified electronic signature through a qualified trust service provider. |\n| `approver` | Reviews and approves documents without signing. |\n| `preparer` | Fills in document fields on behalf of another party. |\n| `automatic_signer` | The signature is applied automatically by the system. |\n",
        "type": "string",
        "enum": [
          "signer",
          "qualified_signer",
          "approver",
          "preparer",
          "automatic_signer"
        ],
        "examples": [
          "signer"
        ]
      },
      "Recipient.Name": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "type": "string",
        "title": "Recipient Name",
        "description": "The full name of the recipient. Appears in invitation emails and is pre-filled for typed signatures.\n",
        "minLength": 1,
        "maxLength": 500,
        "examples": [
          "Jeff Spender"
        ]
      },
      "Deliverable.Id": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Deliverable Id",
        "description": "The unique identifier of the deliverable.",
        "examples": [
          "del_LXRDwyTeJDVrWXmjwxsAGPq"
        ]
      },
      "Deliverable.Name": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "title": "Deliverable Name",
        "description": "A user-provided name for this deliverable. Use this to identify deliverables when an envelope has more than one.\n\nMust start with a lowercase letter and contain only lowercase letters, numbers, and underscores.",
        "type": [
          "string",
          "null"
        ],
        "pattern": "^[a-z][a-z0-9_]*$",
        "minLength": 1,
        "maxLength": 32,
        "examples": [
          "hr_pack",
          "compliance_acceptance"
        ]
      },
      "Deliverable.Type": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "type": "string",
        "title": "Deliverable Type",
        "enum": [
          "simple",
          "standard"
        ],
        "description": "The type of the deliverable.\n\n- `standard` -- Includes signed documents and an audit log with a certificate of completion.\n- `simple` -- Includes signed documents only, without an audit log.\n",
        "examples": [
          "standard"
        ]
      },
      "Deliverable.Url": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": [
          "string",
          "null"
        ],
        "title": "Deliverable Url",
        "format": "uri",
        "description": "The URL to download the deliverable once it has been generated. If the deliverable has not yet been generated, this will be `null`.\n\n## Pre-signed URLs (Default)\n\nBy default, this is a short-lived, pre-signed URL that requires no further authentication to download.\n\nThe URL expires after 1 hour. If the link has expired, you can generate a new one by retrieving the deliverable again.\n\n## Authenticated URLs\n\nIf you requested authenticated URLs, for example to achieve HIPAA compliance, the URL must be accessed using the API key, in the same way as other requests to this API.\n\nAuthenticated URLs do not expire.\n",
        "examples": [
          "https://www.example.com/repository/audit-log.pdf"
        ]
      },
      "Deliverable.IncludedDocuments": {
        "x-schema-role": "model",
        "x-schema-direction": "any",
        "title": "Included Documents",
        "type": "array",
        "description": "The keys of the documents to include in the deliverable.\n\nBy default, all documents in the envelope are included. Use this field to create a deliverable with only a subset of documents, for example to generate separate deliverables for different recipients.",
        "examples": [
          [
            "contract",
            "addendum"
          ]
        ],
        "items": {
          "$ref": "#/components/schemas/Document.Key"
        },
        "minItems": 1,
        "maxItems": 10
      },
      "Envelope.CancelReason": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "type": [
          "string",
          "null"
        ],
        "title": "Envelope Cancel Reason",
        "description": "An optional explanation for why the envelope was canceled. This is for internal use only and is not shown to recipients.\n\nThe reason is included in the `envelope.canceled` webhook event payload, making it available for your records and automated workflows.\n",
        "minLength": 1,
        "maxLength": 2000,
        "examples": [
          "Mars is full. No more explorers allowed."
        ]
      },
      "Event.Id": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "description": "Unique identifier for the event. Uses the `evt_` prefix.",
        "example": "evt_1sAAaVfabdt0esVjmSTmLA"
      },
      "Event.Timestamp": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "title": "Event Timestamp",
        "description": "When the event occurred, in ISO 8601 format.",
        "example": "2025-07-15T14:30:00Z",
        "type": "string",
        "format": "date-time"
      },
      "Event.EventBase": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "description": "Base properties shared by all events. Every event includes a unique identifier and a timestamp recording when the event occurred.",
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Event.Id"
          },
          "timestamp": {
            "$ref": "#/components/schemas/Event.Timestamp"
          }
        },
        "required": [
          "id",
          "timestamp"
        ]
      },
      "Event.Type": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "description": "The type of the event. Determines the category and the shape of the `data` payload. Event types are grouped into four categories: envelope, recipient, deliverable, and sender.",
        "x-enum-descriptions": {
          "envelope.created": "A new envelope was created.",
          "envelope.started": "The envelope finished processing and is ready to send to recipients.",
          "envelope.completed": "All recipients completed (for example, signed) the envelope.",
          "envelope.failed": "The envelope encountered an error and moved to a failed status.",
          "envelope.canceled": "The envelope was canceled through the Cancel Envelope endpoint.",
          "recipient.released": "The recipient is ready to receive a signing request. Status changed to pending.",
          "recipient.sent": "The signing request email was delivered to the recipient.",
          "recipient.accessed": "The recipient entered the signing ceremony.",
          "recipient.viewed": "The recipient authenticated and viewed the documents.",
          "recipient.completed": "The recipient finished signing. Status changed to completed.",
          "recipient.soft_bounced": "The email to the recipient temporarily bounced (for example, full mailbox).",
          "recipient.hard_bounced": "The email to the recipient permanently bounced (for example, invalid address).",
          "recipient.rejected": "The recipient declined the envelope.",
          "recipient.failed": "The recipient encountered a general failure.",
          "recipient.replaced": "The recipient was replaced with a new recipient.",
          "recipient.resent": "The signing request was resent to the recipient.",
          "deliverable.generated": "The signed document was generated and is available for download.",
          "deliverable.failed": "The signed document failed to generate.",
          "sender.created": "A verification request was initiated for a sender.",
          "sender.verified": "The sender completed email verification.",
          "sender.failed": "The sender verification failed.",
          "sender.deleted": "The sender was deleted."
        },
        "example": "envelope.completed",
        "enum": [
          "envelope.created",
          "envelope.started",
          "envelope.completed",
          "envelope.failed",
          "envelope.canceled",
          "recipient.released",
          "recipient.sent",
          "recipient.accessed",
          "recipient.viewed",
          "recipient.completed",
          "recipient.soft_bounced",
          "recipient.hard_bounced",
          "recipient.rejected",
          "recipient.failed",
          "recipient.replaced",
          "recipient.resent",
          "deliverable.generated",
          "deliverable.failed",
          "sender.created",
          "sender.verified",
          "sender.failed",
          "sender.deleted"
        ]
      },
      "Event.ObjectType": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "description": "The type of object this event refers to. Indicates whether the event relates to an envelope, recipient, deliverable, or sender.",
        "x-enum-descriptions": {
          "envelope": "The event relates to an envelope.",
          "recipient": "The event relates to a recipient.",
          "deliverable": "The event relates to a deliverable (signed document).",
          "sender": "The event relates to a sender."
        },
        "example": "envelope",
        "enum": [
          "envelope",
          "recipient",
          "deliverable",
          "sender"
        ]
      },
      "Event.EnvelopeEventData": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "object",
        "description": "Data payload for envelope events. Contains the envelope identifier, object type, and any metadata attached to the envelope.",
        "properties": {
          "envelope_id": {
            "$ref": "#/components/schemas/Envelope.Id"
          },
          "object_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Event.ObjectType"
              },
              {
                "const": "envelope"
              }
            ]
          },
          "object_id": {
            "$ref": "#/components/schemas/Envelope.Id"
          },
          "envelope_metadata": {
            "$ref": "#/components/schemas/Envelope.Metadata"
          }
        },
        "required": [
          "envelope_id",
          "object_type",
          "object_id",
          "envelope_metadata"
        ]
      },
      "Event.EnvelopeCreated": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Envelope Created Event",
        "description": "Fired when a new envelope is created. This is the first event in the envelope lifecycle.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "envelope.created"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.EnvelopeEventData"
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.EnvelopeStarted": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Envelope Started Event",
        "description": "Fired when the envelope finishes processing and is ready to send to recipients. The envelope status changes from `processing` to `in_progress`.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "envelope.started"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.EnvelopeEventData"
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.EnvelopeCompleted": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Envelope Completed Event",
        "description": "Fired when all recipients have completed (for example, signed) the envelope. The envelope status changes from `in_progress` to `completed`.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "envelope.completed"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.EnvelopeEventData"
                  }
                ]
              }
            }
          }
        ]
      },
      "Envelope.FailDetail": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Envelope Fail Detail",
        "description": "A human-readable explanation of what caused the envelope to fail. This detail is included in the `envelope.failed` webhook event payload. Failures are very rare and automatically trigger an alert to the SignatureAPI team.\n",
        "examples": [
          "Could not parse input PDF document."
        ]
      },
      "Event.EnvelopeFailed": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Envelope Failed Event",
        "description": "Fired when the envelope encounters an error. The envelope status changes to `failed`. The `data.detail` field contains the reason for the failure.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "envelope.failed"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.EnvelopeEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "detail": {
                        "$ref": "#/components/schemas/Envelope.FailDetail"
                      }
                    },
                    "required": [
                      "detail"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.EnvelopeCanceled": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Envelope Canceled Event",
        "description": "Fired when the envelope is canceled through the Cancel Envelope endpoint. The envelope status changes to `canceled`. The `data.reason` field contains the cancellation reason, if one was provided.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "envelope.canceled"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.EnvelopeEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "reason": {
                        "$ref": "#/components/schemas/Envelope.CancelReason"
                      }
                    },
                    "required": [
                      "reason"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.RecipientEventData": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "object",
        "description": "Data payload for recipient events. Contains the recipient identifier, the parent envelope identifier, envelope metadata, and recipient details such as type and key.",
        "properties": {
          "envelope_id": {
            "$ref": "#/components/schemas/Envelope.Id"
          },
          "object_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Event.ObjectType"
              },
              {
                "const": "recipient"
              }
            ]
          },
          "object_id": {
            "$ref": "#/components/schemas/Recipient.Id"
          },
          "envelope_metadata": {
            "$ref": "#/components/schemas/Envelope.Metadata"
          },
          "recipient_type": {
            "$ref": "#/components/schemas/Recipient.Type"
          },
          "recipient_key": {
            "$ref": "#/components/schemas/Recipient.Key"
          }
        },
        "required": [
          "envelope_id",
          "object_type",
          "object_id",
          "envelope_metadata",
          "recipient_type",
          "recipient_key"
        ]
      },
      "Event.RecipientReleased": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Released Event",
        "description": "Fired when a recipient is ready to receive a signing request. The recipient status changes to `pending`.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.released"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.RecipientSent": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Sent Event",
        "description": "Fired when the signing request email is delivered to the recipient.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.sent"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  }
                ]
              }
            }
          }
        ]
      },
      "Recipient.IP": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Recipient IP Address",
        "description": "The IP address of the recipient when they accessed the ceremony. Captured from the recipient's browser session.\n\nAvailable in `recipient.accessed` events.\n",
        "examples": [
          "123.122.990.22",
          "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
        ]
      },
      "Recipient.UserAgent": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Recipient User Agent",
        "description": "The browser user agent string of the recipient when they accessed the ceremony. Identifies the recipient's browser and operating system.\n\nAvailable in `recipient.accessed` events.\n",
        "examples": [
          "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
        ]
      },
      "Recipient.SessionId": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Recipient Session ID",
        "description": "A unique identifier for the recipient's ceremony session. Use this to correlate multiple events from the same session, such as `recipient.accessed`, `recipient.viewed`, and `recipient.completed`.\n",
        "examples": [
          "ses_2X6eHBCL84MDGrLQX0mHI72"
        ]
      },
      "Event.RecipientAccessed": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Accessed Event",
        "description": "Fired when the recipient enters the signing ceremony. Emitted at most once every 60 seconds per IP address and user agent to reduce duplicates. The `data` includes the recipient's IP address, user agent, and session ID.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.accessed"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "ip": {
                        "$ref": "#/components/schemas/Recipient.IP"
                      },
                      "user_agent": {
                        "$ref": "#/components/schemas/Recipient.UserAgent"
                      },
                      "session_id": {
                        "$ref": "#/components/schemas/Recipient.SessionId"
                      }
                    },
                    "required": [
                      "ip",
                      "user_agent",
                      "session_id"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.RecipientViewed": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Viewed Event",
        "description": "Fired after the recipient authenticates and views the documents in the signing ceremony. The `data` includes the session ID.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.viewed"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "session_id": {
                        "$ref": "#/components/schemas/Recipient.SessionId"
                      }
                    },
                    "required": [
                      "session_id"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.RecipientCompleted": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Completed Event",
        "description": "Fired when the recipient finishes signing. The recipient status changes to `completed`. The `data` includes the session ID.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.completed"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "session_id": {
                        "$ref": "#/components/schemas/Recipient.SessionId"
                      }
                    }
                  }
                ]
              }
            }
          }
        ]
      },
      "Recipient.BounceDetail": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Recipient Bounce Detail",
        "description": "A human-readable explanation of why the email bounced. Contains information from the remote email server, such as \"Mailbox Full\" or \"User Unknown.\"\n\nPresent when the recipient status is `soft_bounced` or `hard_bounced`.\n",
        "examples": [
          "Permanent/General, diagnostic code: smtp; 550 5.1.1 As requested: user unknown <bounce+mlkav@example.com>"
        ]
      },
      "Event.RecipientSoftBounced": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Soft Bounced Event",
        "description": "Fired when the email to the recipient temporarily bounces. Common causes include a full mailbox or a temporary server issue. The `data.detail` field contains the bounce reason.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.soft_bounced"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "detail": {
                        "$ref": "#/components/schemas/Recipient.BounceDetail"
                      }
                    },
                    "required": [
                      "detail"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.RecipientHardBounced": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Hard Bounced Event",
        "description": "Fired when the email to the recipient permanently bounces. Common causes include an invalid email address. After a hard bounce, you cannot send additional requests to this recipient without using the Replace Recipient endpoint. The `data.detail` field contains the bounce reason.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.hard_bounced"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "detail": {
                        "$ref": "#/components/schemas/Recipient.BounceDetail"
                      }
                    },
                    "required": [
                      "detail"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Recipient.RejectReason": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Recipient Reject Reason",
        "description": "An explanation provided by the recipient for rejecting the envelope. The recipient may optionally enter a reason during the ceremony when they decline to sign.\n\nPresent when the recipient status is `rejected`. May be empty if the recipient did not provide a reason.\n",
        "maxLength": 2000,
        "examples": [
          "Not the terms we agreed to on June."
        ]
      },
      "Event.RecipientRejected": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Rejected Event",
        "description": "Fired when the recipient declines the envelope. The `data.reason` field contains the rejection reason if the recipient provided one. The `data` includes the session ID.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.rejected"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "reason": {
                        "$ref": "#/components/schemas/Recipient.RejectReason"
                      },
                      "session_id": {
                        "$ref": "#/components/schemas/Recipient.SessionId"
                      }
                    },
                    "required": [
                      "reason",
                      "session_id"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Recipient.FailDetail": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Recipient Fail Detail",
        "description": "A human-readable explanation of why the recipient failed. For example, the recipient's email may be on a blocklist.\n\nPresent when the recipient status is `failed`.\n",
        "examples": [
          "Recipient in email blocklist."
        ]
      },
      "Event.RecipientFailed": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Failed Event",
        "description": "Fired when the recipient encounters a general failure. The `data.detail` field contains the failure reason.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.failed"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "detail": {
                        "$ref": "#/components/schemas/Recipient.FailDetail"
                      }
                    },
                    "required": [
                      "detail"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.RecipientReplaced": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Replaced Event",
        "description": "Fired when the recipient is replaced with a new recipient through the Replace Recipient endpoint. The `data` includes the new recipient's ID and name.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.replaced"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "new_recipient_id": {
                        "$ref": "#/components/schemas/Recipient.Id"
                      },
                      "new_recipient_name": {
                        "$ref": "#/components/schemas/Recipient.Name"
                      }
                    },
                    "required": [
                      "new_recipient_id",
                      "new_recipient_name"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.RecipientResent": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Recipient Resent Event",
        "description": "Fired when the signing request is resent to the recipient.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "recipient.resent"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.RecipientEventData"
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.DeliverableEventData": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "object",
        "description": "Data payload for deliverable events. Contains the deliverable identifier, the parent envelope identifier, envelope metadata, deliverable type, name, and the list of included documents.",
        "properties": {
          "envelope_id": {
            "$ref": "#/components/schemas/Envelope.Id"
          },
          "object_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Event.ObjectType"
              },
              {
                "const": "deliverable"
              }
            ]
          },
          "object_id": {
            "$ref": "#/components/schemas/Deliverable.Id"
          },
          "envelope_metadata": {
            "$ref": "#/components/schemas/Envelope.Metadata"
          },
          "deliverable_type": {
            "$ref": "#/components/schemas/Deliverable.Type"
          },
          "deliverable_name": {
            "$ref": "#/components/schemas/Deliverable.Name"
          },
          "included_documents": {
            "$ref": "#/components/schemas/Deliverable.IncludedDocuments"
          }
        },
        "required": [
          "envelope_id",
          "object_type",
          "object_id",
          "envelope_metadata",
          "deliverable_type",
          "deliverable_name",
          "included_documents"
        ]
      },
      "Event.DeliverableGenerated": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Deliverable Generated Event",
        "description": "Fired when the signed document is generated and available for download. The `data.url` field contains a pre-signed, short-lived download link. If the link expires, retrieve a new one through the Get Deliverable endpoint.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "deliverable.generated"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.DeliverableEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "url": {
                        "$ref": "#/components/schemas/Deliverable.Url"
                      }
                    },
                    "required": [
                      "url"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Deliverable.FailDetail": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Deliverable Fail Detail",
        "description": "A human-readable explanation of why the deliverable failed to generate. Only present when the deliverable status is `failed`.",
        "examples": [
          "Recipient in email blocklist."
        ]
      },
      "Event.DeliverableFailed": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Deliverable Failed Event",
        "description": "Fired when the signed document fails to generate. The `data.detail` field contains the failure reason.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "deliverable.failed"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.DeliverableEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "detail": {
                        "$ref": "#/components/schemas/Deliverable.FailDetail"
                      }
                    },
                    "required": [
                      "detail"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Sender.Id": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Sender ID",
        "description": "The unique identifier of the sender.",
        "examples": [
          "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
        ]
      },
      "Sender.Email": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "title": "Sender Email",
        "description": "The email address of the sender. SignatureAPI sends signing request emails to recipients on behalf of this address.",
        "type": "string",
        "format": "email",
        "maxLength": 320,
        "example": "john@example.com"
      },
      "Event.SenderEventData": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "object",
        "description": "Data payload for sender events. Contains the sender identifier, object type, and the sender's email address.",
        "properties": {
          "object_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Event.ObjectType"
              },
              {
                "const": "sender"
              }
            ]
          },
          "object_id": {
            "$ref": "#/components/schemas/Sender.Id"
          },
          "email": {
            "$ref": "#/components/schemas/Sender.Email"
          }
        },
        "required": [
          "object_type",
          "object_id",
          "email"
        ]
      },
      "Event.SenderCreated": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Sender Created Event",
        "description": "Fired when a verification request is initiated for a sender email address.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "sender.created"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.SenderEventData"
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.SenderVerified": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Sender Verified Event",
        "description": "Fired when the sender completes email verification.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "sender.verified"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.SenderEventData"
                  }
                ]
              }
            }
          }
        ]
      },
      "Sender.FailDetail": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Sender Fail Detail",
        "description": "A human-readable explanation of why sender verification failed. Possible reasons include a hard or soft bounce of the verification email, or an internal error.",
        "examples": [
          "Verification email bounced"
        ]
      },
      "Event.SenderFailed": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Sender Failed Event",
        "description": "Fired when sender verification fails. The `data.detail` field contains the failure reason, such as an undeliverable verification email.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "sender.failed"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.SenderEventData"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "detail": {
                        "$ref": "#/components/schemas/Sender.FailDetail"
                      }
                    },
                    "required": [
                      "detail"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "Event.SenderDeleted": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Sender Deleted Event",
        "description": "Fired when a sender is deleted from the account.",
        "allOf": [
          {
            "$ref": "#/components/schemas/Event.EventBase"
          },
          {
            "type": "object",
            "required": [
              "type",
              "data"
            ],
            "properties": {
              "type": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.Type"
                  },
                  {
                    "const": "sender.deleted"
                  }
                ]
              },
              "data": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Event.SenderEventData"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}
