---
title: "Find webhooks"
method: GET
path: "/webhooks"
tags: ["webhooks"]
---

# Find webhooks

`GET /webhooks`

Searches all webhooks available for a current user. Searches by name, resource, event, callback URL, or whether they are enabled. Returns a paged list of Webhooks

## Query parameters

- `fields` string
- `limit` integer
- `offset` integer
- `name` string
- `resource` string
- `event` string
- `callback` string
- `enabled` boolean

## Response `200`

successful operation

- WebhookPage — ~
  - `items` object[] — A list of returned items
    - `id` integer — An id of a webhook
    - `enabled` boolean — A parameter which allows the webhook to send requests to unknown ssl endpoints (ssl certificate verification is disabled)
    - `nonStrictSsl` boolean — A parameter which allows the webhook to send requests to unknown ssl endpoints (ssl certificate verification is disabled)
    - `name` string — A name of a webhook
    - `resource` string — A resource name that webhook is watching events on. Use GET /webhooks/resources to determine resources and events available (ex: InboundCall, OutboundCall, InboundText, OutboundText, CallBroadcast, TextBroadcast, etc...)
    - `events` string[] — Comma separated list of events on resource that will trigger callbacks (ex: STARTED, STOPPED, FINISHED, etc...).
    - `fields` string — A limit callback response to a particular fields
    - `callback` string — URL that webhook will send POST to on resource event trigger
    - `secret` string — Webhook secret token which is used as a signing key to HmacSHA256 hash of json payload which is returned in 'X-CallFire-Signature-256' header. This header can be used to verify callback POST is coming from CallFire. See [security guide](https://developers.callfire.com/security-guide.html)
    - `singleUse` boolean — If true is set then webhook triggers only once. Afterwards the webhook will be deleted
    - `createdAt` integer — A time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000
    - `updatedAt` integer — A time when the given resource was updated, formatted in unix time milliseconds (read only). Example: 1473781817000
    - `expiresAt` integer — ~
  - `limit` integer — A maximum number of returned items. If items.size() < limit assume no more items
  - `offset` integer — An offset from a start of paging source
  - `totalCount` integer — Total count of available results. -1 if unknown

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/callfire/apis/callfire-api-documentation.md) · [All operations](https://skmtc.dev/callfire/apis/callfire-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/callfire/callfire-api-documentation/revisions/9f6fb501bc03/schema)
