---
title: "Query webhooks"
method: GET
path: "/v1/projects/{project_id}/webhooks"
tags: ["Webhook"]
---

# Query webhooks

`GET /v1/projects/{project_id}/webhooks`

## Request

- Base URL: `https://api.telerivet.com`
- URL: `https://api.telerivet.com/v1/projects/{project_id}/webhooks`
- Auth: one of:
  - HTTP basic
  - OAuth 2 (authorization code, authorization URL `https://telerivet.com/oauth/authorize`, token URL `https://api.telerivet.com/oauth/token`)

Queries webhooks within the given project.

## Path parameters

- `project_id` string, required

## Query parameters

- `sort` 'default'
- `sort_dir` 'asc' | 'desc'
- `page_size` integer
- `offset` integer
- `marker` string
- `count` boolean

## Response `200`

Successful response. When count=1 parameter is provided, returns {"count": N} instead.

- object
  - `data` Webhook[]: Array of results (omitted when count=1)
    - `id` string: ID of the webhook
    - `url` string: URL that webhook requests are sent to
    - `secret` string: Secret included with webhook requests for authentication (sent as HTTP basic auth password with username 'telerivet')
    - `events` string[]: Array of event types that trigger this webhook. Possible values: `send_status` (message status updates), `send_broadcast` (broadcast sent), `contact_update` (contact added/updated/deleted), `message_metadata` (message metadata updated)
    - `vars` object: Custom variables stored for this webhook. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.
    - `project_id` string: ID of the project this webhook belongs to
  - `truncated` boolean: True if there are more results
  - `next_marker` string: Marker for pagination
  - `page_size` integer: Number of results per page
  - `sort_dir` 'asc' | 'desc': Sort direction
  - `count` integer: Total count of matching items (only when count=1 parameter is provided)

## Other responses

- `400`: Invalid request parameters
- `401`: Invalid or missing API key or Bearer token
- `404`: Resource not found

---

[API](https://skmtc.dev/telerivet/apis/telerivet-api.md) · [All operations](https://skmtc.dev/telerivet/apis/telerivet-api/llms.txt) · [OpenAPI document](https://skmtc.dev/telerivet/apis/telerivet-api/revisions/4e14b1c8d917?raw)