Create new webhook
POST
/v1/webhooks
Creates new webhook based on the provided request.
Security
API Key
Header parameter name
The API key to use for authentication.
orby-api-key
Header parameters
orby-org-id string Required
The organization id to handle webhook requests for.
Body parameters
object
displayName string
The display name of the webhook.
description string
The description of the webhook.
eventTypes Array of string
Event types that the webhook listens to
The event types that the webhook listens to. Possible values are: 'execution.completed', 'execution.failed', 'execution.cancelled'.
string
status string
Status of the webhook
The status of the webhook. Possible values are: 'enabled', 'disabled'.
endpointUrl string
The URL to which the webhook sends the payload.
workflowIds Array of string
The ids of the workflows which webhook registers on.
string
Responses
| ||
|---|---|---|
Success. Webhook is created successfully. object | ||
The unique identifier of the webhook. displayName string The unique display name of the webhook. description string The description of the webhook. eventTypes Array of string The event types that the webhook listens to. Possible values are: 'execution.completed', 'execution.failed', 'execution.cancelled'. string status string The status of the webhook. Possible values are: 'enabled', 'disabled'. endpointUrl string The URL to which the webhook sends the payload. orgId string The id of the organization which webhook registers on. workflowIds Array of string The ids of the workflow which webhook registers on. string secret string The secret key used to sign the payload. disabledReason string The reason for disabling the webhook. createdAt string (date-time) The timestamp when the webhook was created. createdBy string The id of user who created the webhook. updatedAt string (date-time) The timestamp when the webhook was last updated. | ||
id string
updatedBy string The id of user who updated the webhook. | ||
|---|---|---|
Bad Request. The request is invalid. Please check the request body and try again.
400
{ "code": 0, "message": "string" }
EXAMPLE
Unauthorized. Please check if your API key and organization id are correct.
401
{ "code": 0, "message": "string" }
EXAMPLE
Not Found. The resource you are trying to access does not exist.
404
{ "code": 0, "message": "string" }
EXAMPLE
Rate Limit Exceeded. Please try again later.
429
Internal Server Error. Please try again later or contact Orby support if the issue persists.
500
{ "code": 0, "message": "string" }
EXAMPLE