CRcryptlex
Webhooks

Update a webhook

Changed on

Updates the specified webhook by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

patch/v3/webhooks/{id}

Request

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

Path parameters

idstring required

Unique identifier for the webhook.

Request body

namestring nullable

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 nullable

The endpoint which will receive the HTTP POST payload.

tokenstring nullable

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

enabledboolean nullable

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

eventsstring[] nullable

The list of events which trigger the webhook.

Response

OK

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

      the request property's minLength was increased from 0 to 1

    • 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 the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • 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