PATCH

/v1/workspaces/{workspaceId}/webhook-endpoints/{endpointId}

No description available

Path Parameters

Name	Type	Description
workspaceId required	string	The Workspace whose webhook endpoints to manage
endpointId required	string	Webhook endpoint id

Request Body

{
  url?: string
  description?: string
  eventTypes?: string[]
  enabled?: boolean
}

Responses

200 The updated endpoint

{
  data: {
    id: string
    workspaceId: string
    url: string
    description: string
    eventTypes: string[]
    state: string
    creator: {
      id: string
      name: string
      email: string
    }    failingSince: string
    disabledAt: string
    lastDelivery: {
      status: string
      statusCode: number
      at: string
    }    createdAt: string
    updatedAt: string
  }}

400 Invalid URL or event types

402 The workspace owner is not on Plus

403 Not an owner/admin of the workspace, or the key can't write it

404 Workspace, endpoint or delivery not found

409 Endpoint limit reached

Authentication

Enter your API key to test this endpoint. Get your key from your account settings.

/v1/workspaces/{workspaceId}/webhook-endpoints/{endpointId}

Path Parameters

Request Body

Responses

Authentication

Try it out

Snippets