PlusVibe.ai

List webhooks

GET

https://api.plusvibe.ai/api/v1/hook/list

Webhook

Retrieves a list of all webhooks for the specified workspace. The workspace_id must be provided as a query parameter.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.plusvibe.ai/api/v1/hook/list?workspace_id'

Response Example

200 - Example 1

{
    "hooks": [
        {
            "_id": "675fb344e5c1f6922e9f9eba",
            "workspace_id": "675fb344e5c1f6922e9f9ebb",
            "org_id": "675fb344e5c1f6922e9f9ebc",
            "url": "https://webhook-destination.com",
            "name": "Webhook Name",
            "secret": "string",
            "camp_ids": [
                {}
            ],
            "evt_types": [
                {}
            ],
            "status": "ACTIVE",
            "integration_type": "string",
            "ignore_ooo": 1,
            "ignore_automatic": 1,
            "created_at": "2024-12-16T04:57:40.254Z",
            "modified_at": "2024-12-16T04:57:40.254Z",
            "last_run": "null",
            "last_resp": "null",
            "last_recv_resp": "null",
            "created_by": "65099a0dd96fae8ab61130c1",
            "modified_by": "65099a0dd96fae8ab61130c1"
        }
    ]
}

Request

Query Params

workspace_id

string

required

The ID of the workspace.

Default:

Example:

65099a0dd96fae8ab61130c0

Header Params

x-api-key

string

optional

Your PlusVibe.ai account's API Key

Default:

Example:

your api key

Responses

🟢200OK

application/json

A JSON object containing all webhook information.

Body

hooks

array [object {19}]

optional

_id

string

optional

Unique webhook ID.

Example:

675fb344e5c1f6922e9f9eba

workspace_id

string

optional

The workspace ID this webhook belongs to.

Example:

675fb344e5c1f6922e9f9ebb

org_id

string

optional

The organization ID.

Example:

675fb344e5c1f6922e9f9ebc

url

string

optional

The URL where webhook events are sent.

Example:

https://webhook-destination.com

name

string

optional

A descriptive name for the webhook.

Example:

Webhook Name

secret

string

optional

Optional secret for webhook.

camp_ids

array [object]

optional

List of campaign IDs or ALL.

evt_types

array [object]

optional

The event types that trigger this webhook.

status

string

optional

Current webhook status (ACTIVE/INACTIVE/etc.).

Example:

ACTIVE

integration_type

string

optional

"" for regular webhooks, or "slack" for Slack.

ignore_ooo

integer

optional

1 to ignore out of office replies, 0 otherwise.

Example:

ignore_automatic

integer

optional

1 to ignore automatic replies, 0 otherwise.

Example:

created_at

string <date-time>

optional

Timestamp the webhook was created.

Example:

2024-12-16T04:57:40.254Z

modified_at

string <date-time>

optional

Timestamp the webhook was last modified.

Example:

2024-12-16T04:57:40.254Z

last_run

string

optional

Timestamp of last run.

Example:

null

last_resp

string

optional

Last response sent.

Example:

null

last_recv_resp

string

optional

Last response received.

Example:

null

created_by

string

optional

ID of the user who created the webhook.

Example:

65099a0dd96fae8ab61130c1

modified_by

string

optional

ID of the user who last modified the webhook.

Example:

65099a0dd96fae8ab61130c1

🟠401Unauthorized

Modified at 2025-05-24 05:40:10

Add a new webhook

Delete webhook(s)