Webhooks SDK Reference

Webhooks

List Webhooks

Returns a page of webhooks in the current workspace. By default, the first 20 matching webhooks are ordered by creation time, newest first. Supplied filters are combined, count reports the total number of matches before pagination, and has_more indicates whether another page is available.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.webhooks.list()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.webhooks.list();

  console.log(result);
}

run();

Show Parameters

{
    "page": Optional[int],
    "limit": Optional[int],
    "search": Optional[str],
    "event": Optional[str],
    "sort": Optional[str],
    "direction": Optional[str],
    "content_type": Optional[str],
    "enabled": Optional[bool],
}

{
  page?: number;
  limit?: number;
  search?: string;
  event?: string;
  sort?: string;
  direction?: string;
  contentType?: string;
  enabled?: boolean;
}

Show Response

{
    "count": int,
    "items": [{
        "id": str,
        "url": str,
        "content_type": Literal["application/json", "application/x-www-form-urlencoded"],
        "display_name": str,
        "events": List[str],
        "secret": str,
        "enabled": Optional[bool],
        "failure_count": Optional[int],
        "created_by_id": str,
        "updated_by_id": str,
        "created": date,
        "updated": date,
    }],
    "has_more": bool,
}

{
  count: number;
  items: {
    id: string;
    url: string;
    contentType: "application/json" | "application/x-www-form-urlencoded";
    displayName: string;
    events: string[];
    secret: string;
    enabled?: boolean;
    failureCount?: number;
    createdById: string;
    updatedById: string;
    created: Date;
    updated: Date;
  }[];
  hasMore: boolean;
}

Create a Webhook

Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with GET /v2/webhooks/secret.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.webhooks.create(id="<id>", url="https://outlying-tenement.name/", content_type="application/json", display_name="June.Hand", events=[
        "<value 1>",
        "<value 2>",
    ], secret="<value>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.webhooks.create({
    id: "<id>",
    url: "https://outlying-tenement.name/",
    contentType: "application/json",
    displayName: "June.Hand",
    events: [
      "<value 1>",
      "<value 2>",
    ],
    secret: "<value>",
  });

  console.log(result);
}

run();

Show Parameters

{
    "id": str,  # required
    "url": str,  # required
    "content_type": Literal["application/json", "application/x-www-form-urlencoded"],  # required
    "display_name": str,  # required
    "events": List[str],  # required
    "secret": str,  # required
    "enabled": Optional[bool],
}

{
  id: string;  // required
  url: string;  // required
  contentType: "application/json" | "application/x-www-form-urlencoded";  // required
  displayName: string;  // required
  events: string[];  // required
  secret: string;  // required
  enabled?: boolean;
}

Show Response

{
    "id": str,
    "url": str,
    "content_type": Literal["application/json", "application/x-www-form-urlencoded"],
    "display_name": str,
    "events": List[str],
    "secret": str,
    "enabled": Optional[bool],
    "failure_count": Optional[int],
    "created_by_id": str,
    "updated_by_id": str,
    "created": date,
    "updated": date,
}

{
  id: string;
  url: string;
  contentType: "application/json" | "application/x-www-form-urlencoded";
  displayName: string;
  events: string[];
  secret: string;
  enabled?: boolean;
  failureCount?: number;
  createdById: string;
  updatedById: string;
  created: Date;
  updated: Date;
}

Count Webhooks

Returns the total number of enabled and disabled webhooks in the current workspace.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.webhooks.count()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.webhooks.count();

  console.log(result);
}

run();

Show Response

{
    "total": int,
}

{
  total: number;
}

Query Webhooks [deprecated]

Deprecated. Returns webhooks matching legacy query filters. Use GET /v2/webhooks for pagination, search, event filtering, and sorting.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.webhooks.query()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.webhooks.query({});

  console.log(result);
}

run();

Show Parameters

{
    "pagination": {  # optional
        "page": Optional[int],
        "limit": Optional[int],
        "last_id": Optional[str],
        "first_id": Optional[str],
    },
    "sorting_props": [{  # optional
        "key": Optional[str],
        "direction": Optional[str],
    }],
    "query": Dict[str, Any],  # optional
    "filters": Dict[str, Any],  # optional
    "included_fields": Dict[str, str],  # optional
}

{
  pagination?: {
    page?: number;
    limit?: number;
    lastId?: string;
    firstId?: string;
  };
  sortingProps?: {
    key?: string;
    direction?: string;
  }[];
  query?: Record<string, unknown>;
  filters?: Record<string, unknown>;
  includedFields?: Record<string, string>;
}

Show Response

{
    "count": int,
    "items": [{
        "id": str,
        "url": str,
        "content_type": Literal["application/json", "application/x-www-form-urlencoded"],
        "display_name": str,
        "events": List[str],
        "secret": str,
        "enabled": Optional[bool],
        "failure_count": Optional[int],
        "created_by_id": str,
        "updated_by_id": str,
        "created": date,
        "updated": date,
    }],
}

{
  count: number;
  items: {
    id: string;
    url: string;
    contentType: "application/json" | "application/x-www-form-urlencoded";
    displayName: string;
    events: string[];
    secret: string;
    enabled?: boolean;
    failureCount?: number;
    createdById: string;
    updatedById: string;
    created: Date;
    updated: Date;
  }[];
}

Generate Secret

Generates a signing secret for verifying webhook deliveries. The secret is not persisted until it is used to create or update a webhook; store it securely.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.webhooks.generate_secret()

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.webhooks.generateSecret();

  console.log(result);
}

run();

Show Response

{
    "secret": str,
}

{
  secret: string;
}

Retrieve a Webhook

Retrieves a webhook in the current workspace by ID. The response includes its signing secret; treat it as sensitive.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.webhooks.get(id="<id>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.webhooks.get({
    id: "<id>",
  });

  console.log(result);
}

run();

Show Parameters

{
    "id": str,  # required
}

{
  id: string;  // required
}

Show Response

{
    "id": str,
    "url": str,
    "content_type": Literal["application/json", "application/x-www-form-urlencoded"],
    "display_name": str,
    "events": List[str],
    "secret": str,
    "enabled": Optional[bool],
    "failure_count": Optional[int],
    "created_by_id": str,
    "updated_by_id": str,
    "created": date,
    "updated": date,
}

{
  id: string;
  url: string;
  contentType: "application/json" | "application/x-www-form-urlencoded";
  displayName: string;
  events: string[];
  secret: string;
  enabled?: boolean;
  failureCount?: number;
  createdById: string;
  updatedById: string;
  created: Date;
  updated: Date;
}

Delete a Webhook

Deletes a webhook in the current workspace and returns the deleted webhook ID.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.webhooks.delete(id="<id>")

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.webhooks.delete({
    id: "<id>",
  });

  console.log(result);
}

run();

Show Parameters

{
    "id": str,  # required
}

{
  id: string;  // required
}

Show Response

{
    "id": str,
}

{
  id: string;
}

Update a Webhook

Updates the supplied fields on a webhook in the current workspace. Omitted fields are unchanged. The response contains the applied fields rather than the complete webhook.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.webhooks.update(id="<id>", request_body={})

    # Handle response
    print(res)

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.webhooks.update({
    id: "<id>",
    requestBody: {},
  });

  console.log(result);
}

run();

Show Parameters

{
    "id": str,  # required
    "request_body": Dict[str, Any],  # required
}

{
  id: string;  // required
  requestBody: Record<string, unknown>;  // required
}

Orq SDK

Terminal & Agents

Terraform

Platform APIs

Enterprise APIs (coming soon)

Webhooks

List Webhooks

Create a Webhook

Count Webhooks

Query Webhooks [deprecated]

Generate Secret

Retrieve a Webhook

Delete a Webhook

Update a Webhook

​Webhooks

​List Webhooks

​Create a Webhook

​Count Webhooks

​Query Webhooks [deprecated]

​Generate Secret

​Retrieve a Webhook

​Delete a Webhook

​Update a Webhook

Webhooks

List Webhooks

Create a Webhook

Count Webhooks

Query Webhooks [deprecated]

Generate Secret

Retrieve a Webhook

Delete a Webhook

Update a Webhook