/webhooks/{id}

PATCH /webhooks/{id}

Update a webhook

Update a specific webhook's settings

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

id path integer

The ID of the webhook

Optional Parameters

Click here to view an exhaustive list of all available parameters

x-account-id header string

The account ID for the request

{}

{
  "name": "string",
  "url": "string",
  "description": "string",
  "active": false,
  "headers": {},
  "regenerateSecret": false,
  "events": [
    "string"
  ]
}

Try it out

Output:

Responses

Description

Webhook updated successfully

{
  "id": 0,
  "name": "string",
  "url": "string",
  "active": false,
  "description": "string",
  "headers": {},
  "events": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/WebhookUpdate #/components/schemas/Webhook

#/components/parameters/xAccountIdHeader

OpenAPI
TypeScript

in: header
name: x-account-id
schema:
  type: string
description: The account ID for the request
required: false

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/WebhookUpdate

OpenAPI
TypeScript

type: object
properties:
  name:
    type: string
    description: Name of the webhook
  url:
    type: string
    description: URL where webhook events will be sent
  description:
    type: string
    description: Description of the webhook
  active:
    type: boolean
    description: Whether the webhook is active
  headers:
    type: object
    additionalProperties:
      type: string
    description: Custom headers to send with the webhook request
  regenerateSecret:
    type: boolean
    description: Whether to regenerate the webhook's secret key
  events:
    type: array
    items:
      type: string
    description: List of events to subscribe to

|
export interface WebhookUpdate {
  /** Name of the webhook */
  name?: string;
  /** URL where webhook events will be sent */
  url?: string;
  /** Description of the webhook */
  description?: string;
  /** Whether the webhook is active */
  active?: boolean;
  /** Custom headers to send with the webhook request */
  headers?: Record<string, string>;
  /** Whether to regenerate the webhook's secret key */
  regenerateSecret?: boolean;
  /** List of events to subscribe to */
  events?: string[];
}

#/components/schemas/Webhook

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    readOnly: true
  name:
    type: string
    description: Name of the webhook
  url:
    type: string
    description: URL where webhook events will be sent
  active:
    type: boolean
    description: Whether the webhook is active
  description:
    type: string
    description: Description of the webhook
  headers:
    type: object
    additionalProperties:
      type: string
    description: Custom headers to send with the webhook request
  events:
    type: array
    items:
      type: string
    description: List of events the webhook is subscribed to
  createdAt:
    type: string
    format: date-time
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    readOnly: true
  createdBy:
    type: string
    readOnly: true
  updatedBy:
    type: string
    readOnly: true
required:
  - id
  - name
  - url
  - active
  - events

|
export interface Webhook {
  id: number;
  /** Name of the webhook */
  name: string;
  /** URL where webhook events will be sent */
  url: string;
  /** Whether the webhook is active */
  active: boolean;
  /** Description of the webhook */
  description?: string;
  /** Custom headers to send with the webhook request */
  headers?: Record<string, string>;
  /** List of events the webhook is subscribed to */
  events: string[];
  createdAt?: Date;
  updatedAt?: Date;
  createdBy?: string;
  updatedBy?: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /webhooks/[id]/route.ts

Or the swagger.yaml spec this documentation was generated from: /webhooks/swagger.yaml