Lists webhooks by page
GET
/v1/webhooks
Lists all webhooks
Lists all webhooks based on the provided request parameters.
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.
Query parameters
pageSize integer (int32)
The number of webhooks to return in a single page. Minimum is 1, maximum is 100, default is 20.
pageToken string
The token for fetching the next page of webhooks.
Responses
Success. Webhooks are fetched successfully.
Expand All
object
webhooks Array of object (v1Webhook)
The list of webhooks.
object
id string
The unique identifier of the webhook.
displayName string
The unique display name of the webhook.
200
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.
orgId string
organization id which webhook registers on
The id of the organization which webhook registers on
workflowIds Array of string
The ids of the workflow which webhook registers on.
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.
updatedBy string
The id of user who updated the webhook.
nextPageToken string
The token to retrieve the next page of results.
400
Bad Request. The request is invalid. Please check the request body and try again.
EXAMPLE { "code": 0, "message": "string" }
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