Webhooks

Create a webhook

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.

post/v1/webhooks

Request

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

Request body

urlstring uri required

Where to POST events. HTTPS on a public address.

eventsstring[]

The events to send.

scope'all' | 'drops'

all: every search. drops: only searches a drop made.

dropIdstring uuid

Only searches this drop made. Implies scope drops.

Response

OK

idstring uuid required
urlstring required
eventsstring[] required
scope'all' | 'drops' required
dropIdstring uuid nullable required
enabledboolean required
disabledReason'failing' nullable required
lastSuccessAtstring date-time nullable required
lastFailureAtstring date-time nullable required
lastErrorstring nullable required
createdAtstring date-time required
secretstring starts_with required

Changes

No recorded changes to this operation across all 1 revision of this API.