POST yousign/webhook

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
event_id	string	None.
event_name	string	None.
event_time	string	None.
subscription_id	string	None.
subscription_description	string	None.
sandbox	boolean	None.
data	Data	None.

Request Formats

application/json, text/json

Sample:

{
  "event_id": "sample string 1",
  "event_name": "sample string 2",
  "event_time": "sample string 3",
  "subscription_id": "sample string 4",
  "subscription_description": "sample string 5",
  "sandbox": true,
  "data": {
    "signature_request": {
      "created_at": "sample string 1",
      "deleted_at": "sample string 2",
      "delivery_mode": "sample string 3",
      "documents": [
        {
          "id": "sample string 1",
          "nature": "sample string 2"
        },
        {
          "id": "sample string 1",
          "nature": "sample string 2"
        }
      ],
      "email_custom_note": "sample string 4",
      "expiration_date": "sample string 5",
      "external_id": "sample string 6",
      "id": "sample string 7",
      "name": "sample string 8",
      "ordered_signers": true,
      "reminder_settings": {},
      "sender": {},
      "signers": [
        {
          "id": "sample string 1",
          "status": "sample string 2",
          "info": {
            "first_name": "sample string 1",
            "last_name": "sample string 2",
            "email": "sample string 3",
            "phone_number": "sample string 4",
            "locale": "sample string 5"
          },
          "signature_link": "sample string 3",
          "signature_link_expiration_date": "sample string 4",
          "signature_image_preview": "sample string 5",
          "fields": [
            {
              "id": "sample string 1",
              "document_id": "sample string 2",
              "type": "sample string 3",
              "page": 4,
              "x": 5,
              "y": 6,
              "height": 7,
              "width": 8
            },
            {
              "id": "sample string 1",
              "document_id": "sample string 2",
              "type": "sample string 3",
              "page": 4,
              "x": 5,
              "y": 6,
              "height": 7,
              "width": 8
            }
          ],
          "signature_level": "sample string 6",
          "signature_authentication_mode": "sample string 7",
          "redirect_urls": {},
          "custom_text": {
            "request_subject": "sample string 1",
            "request_body": "sample string 2",
            "reminder_subject": "sample string 3",
            "reminder_body": "sample string 4"
          },
          "delivery_mode": "sample string 9",
          "identification_attestation_id": "sample string 10",
          "sms_notification": {}
        },
        {
          "id": "sample string 1",
          "status": "sample string 2",
          "info": {
            "first_name": "sample string 1",
            "last_name": "sample string 2",
            "email": "sample string 3",
            "phone_number": "sample string 4",
            "locale": "sample string 5"
          },
          "signature_link": "sample string 3",
          "signature_link_expiration_date": "sample string 4",
          "signature_image_preview": "sample string 5",
          "fields": [
            {
              "id": "sample string 1",
              "document_id": "sample string 2",
              "type": "sample string 3",
              "page": 4,
              "x": 5,
              "y": 6,
              "height": 7,
              "width": 8
            },
            {
              "id": "sample string 1",
              "document_id": "sample string 2",
              "type": "sample string 3",
              "page": 4,
              "x": 5,
              "y": 6,
              "height": 7,
              "width": 8
            }
          ],
          "signature_level": "sample string 6",
          "signature_authentication_mode": "sample string 7",
          "redirect_urls": {},
          "custom_text": {
            "request_subject": "sample string 1",
            "request_body": "sample string 2",
            "reminder_subject": "sample string 3",
            "reminder_body": "sample string 4"
          },
          "delivery_mode": "sample string 9",
          "identification_attestation_id": "sample string 10",
          "sms_notification": {}
        }
      ],
      "source": "sample string 12",
      "status": "sample string 13",
      "timezone": "sample string 14",
      "phone_number": "sample string 15"
    },
    "signer": {
      "id": "sample string 1",
      "status": "sample string 2",
      "info": {
        "first_name": "sample string 1",
        "last_name": "sample string 2",
        "email": "sample string 3",
        "phone_number": "sample string 4",
        "locale": "sample string 5"
      },
      "signature_link": "sample string 3",
      "signature_link_expiration_date": "sample string 4",
      "signature_image_preview": "sample string 5",
      "fields": [
        {
          "id": "sample string 1",
          "document_id": "sample string 2",
          "type": "sample string 3",
          "page": 4,
          "x": 5,
          "y": 6,
          "height": 7,
          "width": 8
        },
        {
          "id": "sample string 1",
          "document_id": "sample string 2",
          "type": "sample string 3",
          "page": 4,
          "x": 5,
          "y": 6,
          "height": 7,
          "width": 8
        }
      ],
      "signature_level": "sample string 6",
      "signature_authentication_mode": "sample string 7",
      "redirect_urls": {},
      "custom_text": {
        "request_subject": "sample string 1",
        "request_body": "sample string 2",
        "reminder_subject": "sample string 3",
        "reminder_body": "sample string 4"
      },
      "delivery_mode": "sample string 9",
      "identification_attestation_id": "sample string 10",
      "sms_notification": {}
    }
  }
}

application/xml, text/xml

Sample:

<Message xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YouSignApiClient.DTO.Webhook">
  <data>
    <signature_request>
      <created_at>sample string 1</created_at>
      <deleted_at>sample string 2</deleted_at>
      <delivery_mode>sample string 3</delivery_mode>
      <documents>
        <Document>
          <id>sample string 1</id>
          <nature>sample string 2</nature>
        </Document>
        <Document>
          <id>sample string 1</id>
          <nature>sample string 2</nature>
        </Document>
      </documents>
      <email_custom_note>sample string 4</email_custom_note>
      <expiration_date>sample string 5</expiration_date>
      <external_id>sample string 6</external_id>
      <id>sample string 7</id>
      <name>sample string 8</name>
      <ordered_signers>true</ordered_signers>
      <phone_number>sample string 14</phone_number>
      <reminder_settings />
      <sender />
      <signers xmlns:d4p1="http://schemas.datacontract.org/2004/07/YouSignApiClient.DTO">
        <d4p1:Signer>
          <d4p1:custom_text>
            <d4p1:reminder_body>sample string 4</d4p1:reminder_body>
            <d4p1:reminder_subject>sample string 3</d4p1:reminder_subject>
            <d4p1:request_body>sample string 2</d4p1:request_body>
            <d4p1:request_subject>sample string 1</d4p1:request_subject>
          </d4p1:custom_text>
          <d4p1:delivery_mode>sample string 9</d4p1:delivery_mode>
          <d4p1:fields>
            <d4p1:SignerFields>
              <d4p1:document_id>sample string 2</d4p1:document_id>
              <d4p1:height>7</d4p1:height>
              <d4p1:id>sample string 1</d4p1:id>
              <d4p1:page>4</d4p1:page>
              <d4p1:type>sample string 3</d4p1:type>
              <d4p1:width>8</d4p1:width>
              <d4p1:x>5</d4p1:x>
              <d4p1:y>6</d4p1:y>
            </d4p1:SignerFields>
            <d4p1:SignerFields>
              <d4p1:document_id>sample string 2</d4p1:document_id>
              <d4p1:height>7</d4p1:height>
              <d4p1:id>sample string 1</d4p1:id>
              <d4p1:page>4</d4p1:page>
              <d4p1:type>sample string 3</d4p1:type>
              <d4p1:width>8</d4p1:width>
              <d4p1:x>5</d4p1:x>
              <d4p1:y>6</d4p1:y>
            </d4p1:SignerFields>
          </d4p1:fields>
          <d4p1:id>sample string 1</d4p1:id>
          <d4p1:identification_attestation_id>sample string 10</d4p1:identification_attestation_id>
          <d4p1:info>
            <d4p1:email>sample string 3</d4p1:email>
            <d4p1:first_name>sample string 1</d4p1:first_name>
            <d4p1:last_name>sample string 2</d4p1:last_name>
            <d4p1:locale>sample string 5</d4p1:locale>
            <d4p1:phone_number>sample string 4</d4p1:phone_number>
          </d4p1:info>
          <d4p1:redirect_urls />
          <d4p1:signature_authentication_mode>sample string 7</d4p1:signature_authentication_mode>
          <d4p1:signature_image_preview>sample string 5</d4p1:signature_image_preview>
          <d4p1:signature_level>sample string 6</d4p1:signature_level>
          <d4p1:signature_link>sample string 3</d4p1:signature_link>
          <d4p1:signature_link_expiration_date>sample string 4</d4p1:signature_link_expiration_date>
          <d4p1:sms_notification />
          <d4p1:status>sample string 2</d4p1:status>
        </d4p1:Signer>
        <d4p1:Signer>
          <d4p1:custom_text>
            <d4p1:reminder_body>sample string 4</d4p1:reminder_body>
            <d4p1:reminder_subject>sample string 3</d4p1:reminder_subject>
            <d4p1:request_body>sample string 2</d4p1:request_body>
            <d4p1:request_subject>sample string 1</d4p1:request_subject>
          </d4p1:custom_text>
          <d4p1:delivery_mode>sample string 9</d4p1:delivery_mode>
          <d4p1:fields>
            <d4p1:SignerFields>
              <d4p1:document_id>sample string 2</d4p1:document_id>
              <d4p1:height>7</d4p1:height>
              <d4p1:id>sample string 1</d4p1:id>
              <d4p1:page>4</d4p1:page>
              <d4p1:type>sample string 3</d4p1:type>
              <d4p1:width>8</d4p1:width>
              <d4p1:x>5</d4p1:x>
              <d4p1:y>6</d4p1:y>
            </d4p1:SignerFields>
            <d4p1:SignerFields>
              <d4p1:document_id>sample string 2</d4p1:document_id>
              <d4p1:height>7</d4p1:height>
              <d4p1:id>sample string 1</d4p1:id>
              <d4p1:page>4</d4p1:page>
              <d4p1:type>sample string 3</d4p1:type>
              <d4p1:width>8</d4p1:width>
              <d4p1:x>5</d4p1:x>
              <d4p1:y>6</d4p1:y>
            </d4p1:SignerFields>
          </d4p1:fields>
          <d4p1:id>sample string 1</d4p1:id>
          <d4p1:identification_attestation_id>sample string 10</d4p1:identification_attestation_id>
          <d4p1:info>
            <d4p1:email>sample string 3</d4p1:email>
            <d4p1:first_name>sample string 1</d4p1:first_name>
            <d4p1:last_name>sample string 2</d4p1:last_name>
            <d4p1:locale>sample string 5</d4p1:locale>
            <d4p1:phone_number>sample string 4</d4p1:phone_number>
          </d4p1:info>
          <d4p1:redirect_urls />
          <d4p1:signature_authentication_mode>sample string 7</d4p1:signature_authentication_mode>
          <d4p1:signature_image_preview>sample string 5</d4p1:signature_image_preview>
          <d4p1:signature_level>sample string 6</d4p1:signature_level>
          <d4p1:signature_link>sample string 3</d4p1:signature_link>
          <d4p1:signature_link_expiration_date>sample string 4</d4p1:signature_link_expiration_date>
          <d4p1:sms_notification />
          <d4p1:status>sample string 2</d4p1:status>
        </d4p1:Signer>
      </signers>
      <source>sample string 12</source>
      <status>sample string 13</status>
      <workspace_id>sample string 15</workspace_id>
    </signature_request>
    <signer xmlns:d3p1="http://schemas.datacontract.org/2004/07/YouSignApiClient.DTO">
      <d3p1:custom_text>
        <d3p1:reminder_body>sample string 4</d3p1:reminder_body>
        <d3p1:reminder_subject>sample string 3</d3p1:reminder_subject>
        <d3p1:request_body>sample string 2</d3p1:request_body>
        <d3p1:request_subject>sample string 1</d3p1:request_subject>
      </d3p1:custom_text>
      <d3p1:delivery_mode>sample string 9</d3p1:delivery_mode>
      <d3p1:fields>
        <d3p1:SignerFields>
          <d3p1:document_id>sample string 2</d3p1:document_id>
          <d3p1:height>7</d3p1:height>
          <d3p1:id>sample string 1</d3p1:id>
          <d3p1:page>4</d3p1:page>
          <d3p1:type>sample string 3</d3p1:type>
          <d3p1:width>8</d3p1:width>
          <d3p1:x>5</d3p1:x>
          <d3p1:y>6</d3p1:y>
        </d3p1:SignerFields>
        <d3p1:SignerFields>
          <d3p1:document_id>sample string 2</d3p1:document_id>
          <d3p1:height>7</d3p1:height>
          <d3p1:id>sample string 1</d3p1:id>
          <d3p1:page>4</d3p1:page>
          <d3p1:type>sample string 3</d3p1:type>
          <d3p1:width>8</d3p1:width>
          <d3p1:x>5</d3p1:x>
          <d3p1:y>6</d3p1:y>
        </d3p1:SignerFields>
      </d3p1:fields>
      <d3p1:id>sample string 1</d3p1:id>
      <d3p1:identification_attestation_id>sample string 10</d3p1:identification_attestation_id>
      <d3p1:info>
        <d3p1:email>sample string 3</d3p1:email>
        <d3p1:first_name>sample string 1</d3p1:first_name>
        <d3p1:last_name>sample string 2</d3p1:last_name>
        <d3p1:locale>sample string 5</d3p1:locale>
        <d3p1:phone_number>sample string 4</d3p1:phone_number>
      </d3p1:info>
      <d3p1:redirect_urls />
      <d3p1:signature_authentication_mode>sample string 7</d3p1:signature_authentication_mode>
      <d3p1:signature_image_preview>sample string 5</d3p1:signature_image_preview>
      <d3p1:signature_level>sample string 6</d3p1:signature_level>
      <d3p1:signature_link>sample string 3</d3p1:signature_link>
      <d3p1:signature_link_expiration_date>sample string 4</d3p1:signature_link_expiration_date>
      <d3p1:sms_notification />
      <d3p1:status>sample string 2</d3p1:status>
    </signer>
  </data>
  <event_id>sample string 1</event_id>
  <event_name>sample string 2</event_name>
  <event_time>sample string 3</event_time>
  <sandbox>true</sandbox>
  <subscription_description>sample string 5</subscription_description>
  <subscription_id>sample string 4</subscription_id>
</Message>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.