Webhooks

These endpoints allow you to manage webhooks for receiving notifications about events.

Webhooks can be configured to receive notifications when specific events occur in the system. Each webhook requires a URL where notifications will be sent, a secret key for signature verification, and a list of events to subscribe to.

Endpoints

get /api/v3/notification/webhooks post /api/v3/notification/webhooks delete /api/v3/notification/webhooks/:resource_id get /api/v3/notification/webhooks/:resource_id patch /api/v3/notification/webhooks/:resource_id get /api/v3/notification/webhooks/events post /api/v3/notification/webhooks/test/:id

get/api/v3/notification/webhooks

Return a paginated list of notification/webhooks

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
account_id?: unknown
name?: unknown
url?: unknown
secret?: unknown
events?: unknown
scopes?: unknown
created_at?: unknown
updated_at?: unknown
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    account_id?: any;
    name?: any;
    url?: any;
    secret?: any;
    events?: any;
    scopes?: any;
    created_at?: any;
    updated_at?: any;
  };
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
account_id?: integer
name?: string
url?: string
secret?: string
events?: array
scopes?: open struct
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      account_id?: number;
      name?: string;
      url?: string;
      secret?: string;
      events?: Array<any>;
      scopes?: Record<string, any>;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/notification/webhooks

Create a new notification/webhooks

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
account_id?: integer
name?: string
url?: string
secret?: string
events?: array
scopes?: open struct
created_at?: datetime
updated_at?: datetime

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      account_id?: number;
      name?: string;
      url?: string;
      secret?: string;
      events?: Array<any>;
      scopes?: Record<string, any>;
      created_at?: Date;
      updated_at?: Date;
    };
  };
};

delete/api/v3/notification/webhooks/:resource_id

Delete the notification/webhooks

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/notification/webhooks/:resource_id

Show a specific notification/webhooks

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
account_id?: integer
name?: string
url?: string
secret?: string
events?: array
scopes?: open struct
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      account_id?: number;
      name?: string;
      url?: string;
      secret?: string;
      events?: Array<any>;
      scopes?: Record<string, any>;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/notification/webhooks/:resource_id

Update a notification/webhooks

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
name?: string
url?: string
secret?: string
events?: array

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      url?: string;
      secret?: string;
      events?: Array<any>;
    };
  };
};

get/api/v3/notification/webhooks/events

Returns a list of available events that can be subscribed to via webhooks.

post/api/v3/notification/webhooks/test/:id

Sends a test notification to the webhook to verify it’s working correctly.

Input Schema

object
id: integer

Typescript

type InputSchema = { id: number };

Output Schema

object
success: boolean
message: string

Typescript

type OutputSchema = { success: boolean; message: string };