POST

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

No description available

Path Parameters

Name	Type	Description
workspaceId required	string	The Workspace whose webhook endpoints to manage

Request Body

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

Responses

201 Created. The signing secret is returned here once; a test event was sent.

{
  data: {
    endpoint: {
      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
    }    secret: string
    test: {
      ok: boolean
      statusCode: number
      durationMs: number
      error: 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

Path Parameters

Request Body

Responses

Authentication

Try it out

Snippets