YOyousign
Webhook

Create a Webhook subscription

Changed on

Creates a new Webhook subscription in your organization.

post/webhooks

Request

Request body

endpointstring uri required

HTTPS target URL that will receive webhook POST requests. It must be publicly accessible and may include a specified port.

descriptionstring safe-string nullable required

Short description of the webhook.
This property is a Safe String.

sandboxboolean required
secret_keystring nullable

Autogenerated 32 bytes key

auto_retryboolean required

If a Webhook request fails for any reason, Youtrust will retry the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300, 1080, 1440, 2880 min

enabledboolean required

Choose whether the webhook is enabled or not.

Example request

{
  "endpoint": "https://example.com:port/my-endpoint",
  "description": "Lorem Ipsum",
  "sandbox": true,
  "workspaces": [
    "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
  ]
}

Response

Created

idstring uuid required
endpointstring uri required

HTTPS target URL that will receive webhook POST requests. It must be publicly accessible and may include a specified port.

descriptionstring nullable required

Short description of the webhook

sandboxboolean required
secret_keystring required

Autogenerated 32 bytes key

auto_retryboolean required

If a Webhook request fails for any reason, Youtrust will retry the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300, 1080, 1440, 2880 min

enabledboolean required

Is the webhook enabled?

created_atstring date-time required
updated_atstring date-time nullable required

Example response

{
  "id": "89120884-d29a-4b1a-ac7b-a9e73a872795",
  "endpoint": "https://example.com:port/my-endpoint",
  "description": "Lorem Ipsum",
  "workspaces": [
    "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
  ],
  "created_at": "2024-01-18T22:59:00Z",
  "updated_at": "2024-01-18T22:59:00Z"
}

Changes

  • d70860094a83Revision changes
    • warning

      added the new monitoring.natural_person.activated enum value to the // response property for the response status

    • warning

      added the new monitoring.natural_person.canceled enum value to the // response property for the response status

    • warning

      added the new monitoring.natural_person.inconclusive enum value to the // response property for the response status

    • warning

      added the new monitoring.natural_person.updated enum value to the // response property for the response status

    • warning

      added the new verification.identity_video.revised enum value to the // response property for the response status

    • warning

      added the new verification.signature_seal.done enum value to the // response property for the response status

    • info

      added the new monitoring.natural_person.activated enum value to the request property //

    • info

      added the new monitoring.natural_person.canceled enum value to the request property //

    • info

      added the new monitoring.natural_person.inconclusive enum value to the request property //

    • info

      added the new monitoring.natural_person.updated enum value to the request property //

    • info

      added the new verification.identity_video.revised enum value to the request property //

    • info

      added the new verification.signature_seal.done enum value to the request property //