Webhook

Create a new webhook subscription to receive event notifications at the specified URL.

post/api/v1/webhooks

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/webhooks
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

callbackTimeoutstring duration nullable
descriptionstring

An optional description of the webhook's purpose.

displayNamestring required

The human-readable name for the new webhook.

urlstring required

The destination URL that will receive event notification HTTP callbacks.

Response

Successful response

Changes

    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the request property became nullable

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status