---
title: "Create a webhook"
method: POST
path: "/v1/webhooks"
tags: ["Webhooks"]
---

# Create a webhook

`POST /v1/webhooks`

## Request

- Base URL: `https://api.nvoke.run`
- URL: `https://api.nvoke.run/v1/webhooks`
- Auth: HTTP bearer

We POST `lead.ready` for every company with a valid address once its checks settle, and `search.finished` when a search ends. `scope` `drops` or a `dropId` limits it to searches drops made. Requests are signed the Standard Webhooks way (`webhook-id`, `webhook-timestamp`, `webhook-signature`); the response holds the signing secret, and it is never shown again. HTTPS on a public address only. At most 10 webhooks.

## Request body

- object
  - `url` string, uri, required: Where to POST events. HTTPS on a public address.
  - `events` string[]: The events to send.
  - `scope` 'all' | 'drops': `all`: every search. `drops`: only searches a drop made.
  - `dropId` string, uuid: Only searches this drop made. Implies scope `drops`.

## Response `201`

OK

- object
  - `id` string, uuid, required
  - `url` string, required
  - `events` string[], required
  - `scope` 'all' | 'drops', required
  - `dropId` string, uuid, nullable, required
  - `enabled` boolean, required
  - `disabledReason` 'failing', nullable, required
  - `lastSuccessAt` string, date-time, nullable, required
  - `lastFailureAt` string, date-time, nullable, required
  - `lastError` string, nullable, required
  - `createdAt` string, date-time, required
  - `secret` string, starts_with, required

## Other responses

- `4XX`: `unauthorized`: No valid token. Send `Authorization: Bearer <key>`. `invalid_request`: The body or query failed validation. `details` lists the problems. `too_many_webhooks`: The account holds 10 webhooks. Delete one first. `webhook_url_not_allowed`: Webhook URLs must be HTTPS on a public address that resolves.

---

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