CRcryptlex
Webhooks

Create a webhook

Changed on

Creates a new webhook.

post/v3/webhooks

Request

  • Base URL
    https://api.cryptlex.com
  • URL
    https://api.cryptlex.com/v3/webhooks
  • Auth
    HTTP bearer

Request body

namestring required

Name of the webhook.

Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

urlstring uri required

The endpoint which will receive the HTTP POST payload.

tokenstring required

The secret which will be used to sign the payload using HMAC256 algorithm.

enabledboolean required

Whether webhook is enabled, you can use it to disable a webhook.

eventsstring[] required

The list of events which trigger the webhook.

Response

Created

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
urlstring required
tokenstring required
enabledboolean required
status'healthy' | 'unhealthy' | 'suspended' required
eventsstring[] required

Changes

  • 66dcb6293180Revision changes
    • breaking

      added the pattern ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$ to the request property

  • ec1259c12475Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • warning

      removed subschema #2 from the request body allOf list

    • warning

      removed the optional property from the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status