nvoke Webhooks API

The Webhooks API from nvoke — 4 operation(s) for webhooks.

GitHub OpenAPI

Operations 7

GET /v1/webhooks List webhooks #
POST /v1/webhooks Create a webhook #
GET /v1/webhooks/{id} Get a webhook #
PATCH /v1/webhooks/{id} Change a webhook #
DELETE /v1/webhooks/{id} Delete a webhook #
POST /v1/webhooks/{id}/test Send a test event #
GET /v1/webhooks/{id}/deliveries Recent deliveries #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nvoke-run:nvoke-run-webhooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nvoke-run-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: nvoke Webhooks API
  version: 0.1.0
  description: 'Find companies, read their websites and get email addresses checked with the mail server. Everything the desktop app does. Send `Authorization: Bearer `.'
servers:
- url: https://api.nvoke.run
tags:
- name: Webhooks
paths:
  /v1/webhooks:
    get:
      operationId: listWebhooks
      summary: List webhooks
      description: 'Your webhooks with the outcome of their last deliveries. A webhook we turned off after a day of failures has `enabled: false` and `disabledReason` `failing`.'
      tags:
      - Webhooks
      security:
      - bearer: []
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        url:
                          type: string
                        events:
                          type: array
                          items:
                            type: string
                            enum:
                            - lead.ready
                            - search.finished
                        scope:
                          type: string
                          enum:
                          - all
                          - drops
                        dropId:
                          anyOf:
                          - type: string
                            format: uuid
                            pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          - type: 'null'
                        enabled:
                          type: boolean
                        disabledReason:
                          anyOf:
                          - type: string
                            enum:
                            - failing
                          - type: 'null'
                        lastSuccessAt:
                          anyOf:
                          - type: string
                            format: date-time
                            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                          - type: 'null'
                        lastFailureAt:
                          anyOf:
                          - type: string
                            format: date-time
                            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                          - type: 'null'
                        lastError:
                          type:
                          - string
                          - 'null'
                        createdAt:
                          type: string
                          format: date-time
                          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                      required:
                      - id
                      - url
                      - events
                      - scope
                      - dropId
                      - enabled
                      - disabledReason
                      - lastSuccessAt
                      - lastFailureAt
                      - lastError
                      - createdAt
                      additionalProperties: false
                required:
                - webhooks
                additionalProperties: false
        4XX:
          description: '`unauthorized`: No valid token. Send `Authorization: Bearer <key>`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createWebhook
      summary: Create a webhook
      description: 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.
      tags:
      - Webhooks
      security:
      - bearer: []
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  maxLength: 2000
                  format: uri
                  description: Where to POST events. HTTPS on a public address.
                events:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    enum:
                    - lead.ready
                    - search.finished
                  description: The events to send.
                scope:
                  type: string
                  enum:
                  - all
                  - drops
                  description: '`all`: every search. `drops`: only searches a drop made.'
                dropId:
                  type: string
                  format: uuid
                  pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  description: Only searches this drop made. Implies scope `drops`.
              required:
              - url
            example:
              url: https://example.com/hooks/nvoke
              events:
              - lead.ready
              scope: drops
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  url:
                    type: string
                  events:
                    type: array
                    items:
                      type: string
                      enum:
                      - lead.ready
                      - search.finished
                  scope:
                    type: string
                    enum:
                    - all
                    - drops
                  dropId:
                    anyOf:
                    - type: string
                      format: uuid
                      pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    - type: 'null'
                  enabled:
                    type: boolean
                  disabledReason:
                    anyOf:
                    - type: string
                      enum:
                      - failing
                    - type: 'null'
                  lastSuccessAt:
                    anyOf:
                    - type: string
                      format: date-time
                      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                    - type: 'null'
                  lastFailureAt:
                    anyOf:
                    - type: string
                      format: date-time
                      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                    - type: 'null'
                  lastError:
                    type:
                    - string
                    - 'null'
                  createdAt:
                    type: string
                    format: date-time
                    pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                  secret:
                    type: string
                    format: starts_with
                    pattern: ^whsec_.*
                required:
                - id
                - url
                - events
                - scope
                - dropId
                - enabled
                - disabledReason
                - lastSuccessAt
                - lastFailureAt
                - lastError
                - createdAt
                - secret
                additionalProperties: false
        4XX:
          description: '`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.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/webhooks/{id}:
    get:
      operationId: getWebhook
      summary: Get a webhook
      description: One webhook with the outcome of its last deliveries. The signing secret is not shown again.
      tags:
      - Webhooks
      security:
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  url:
                    type: string
                  events:
                    type: array
                    items:
                      type: string
                      enum:
                      - lead.ready
                      - search.finished
                  scope:
                    type: string
                    enum:
                    - all
                    - drops
                  dropId:
                    anyOf:
                    - type: string
                      format: uuid
                      pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    - type: 'null'
                  enabled:
                    type: boolean
                  disabledReason:
                    anyOf:
                    - type: string
                      enum:
                      - failing
                    - type: 'null'
                  lastSuccessAt:
                    anyOf:
                    - type: string
                      format: date-time
                      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                    - type: 'null'
                  lastFailureAt:
                    anyOf:
                    - type: string
                      format: date-time
                      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                    - type: 'null'
                  lastError:
                    type:
                    - string
                    - 'null'
                  createdAt:
                    type: string
                    format: date-time
                    pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                required:
                - id
                - url
                - events
                - scope
                - dropId
                - enabled
                - disabledReason
                - lastSuccessAt
                - lastFailureAt
                - lastError
                - createdAt
                additionalProperties: false
        4XX:
          description: '`unauthorized`: No valid token. Send `Authorization: Bearer <key>`.


            `not_found`: No such search, company, email, drop, key or webhook on this account.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      operationId: updateWebhook
      summary: Change a webhook
      description: 'Change the URL, events or scope, or pause and resume it with `enabled`. `dropId: null` widens it to the whole scope again.'
      tags:
      - Webhooks
      security:
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  maxLength: 2000
                  format: uri
                  description: Where to POST events. HTTPS on a public address.
                events:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    enum:
                    - lead.ready
                    - search.finished
                  description: The events to send.
                scope:
                  type: string
                  enum:
                  - all
                  - drops
                  description: '`all`: every search. `drops`: only searches a drop made.'
                dropId:
                  anyOf:
                  - type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    description: Only searches this drop made. Implies scope `drops`.
                  - type: 'null'
                enabled:
                  type: boolean
            example:
              enabled: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  url:
                    type: string
                  events:
                    type: array
                    items:
                      type: string
                      enum:
                      - lead.ready
                      - search.finished
                  scope:
                    type: string
                    enum:
                    - all
                    - drops
                  dropId:
                    anyOf:
                    - type: string
                      format: uuid
                      pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    - type: 'null'
                  enabled:
                    type: boolean
                  disabledReason:
                    anyOf:
                    - type: string
                      enum:
                      - failing
                    - type: 'null'
                  lastSuccessAt:
                    anyOf:
                    - type: string
                      format: date-time
                      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                    - type: 'null'
                  lastFailureAt:
                    anyOf:
                    - type: string
                      format: date-time
                      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                    - type: 'null'
                  lastError:
                    type:
                    - string
                    - 'null'
                  createdAt:
                    type: string
                    format: date-time
                    pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                required:
                - id
                - url
                - events
                - scope
                - dropId
                - enabled
                - disabledReason
                - lastSuccessAt
                - lastFailureAt
                - lastError
                - createdAt
                additionalProperties: false
        4XX:
          description: '`unauthorized`: No valid token. Send `Authorization: Bearer <key>`.


            `not_found`: No such search, company, email, drop, key or webhook on this account.


            `invalid_request`: The body or query failed validation. `details` lists the problems.


            `webhook_url_not_allowed`: Webhook URLs must be HTTPS on a public address that resolves.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteWebhook
      summary: Delete a webhook
      description: Stops it at once and drops its pending deliveries.
      tags:
      - Webhooks
      security:
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '204':
          description: No content
        4XX:
          description: '`unauthorized`: No valid token. Send `Authorization: Bearer <key>`.


            `not_found`: No such search, company, email, drop, key or webhook on this account.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/webhooks/{id}/test:
    post:
      operationId: testWebhook
      summary: Send a test event
      description: Sends a signed `ping` event right now and tells you how your server answered.
      tags:
      - Webhooks
      security:
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  status:
                    anyOf:
                    - type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    - type: 'null'
                  error:
                    type:
                    - string
                    - 'null'
                  durationMs:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                required:
                - ok
                - status
                - error
                - durationMs
                additionalProperties: false
        4XX:
          description: '`unauthorized`: No valid token. Send `Authorization: Bearer <key>`.


            `not_found`: No such search, company, email, drop, key or webhook on this account.


            `webhook_url_not_allowed`: Webhook URLs must be HTTPS on a public address that resolves.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/webhooks/{id}/deliveries:
    get:
      operationId: listWebhookDeliveries
      summary: Recent deliveries
      description: The last 50 deliveries with their status, attempts and the last answer from your server. Kept 30 days.
      tags:
      - Webhooks
      security:
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  deliveries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        event:
                          type: string
                          enum:
                          - lead.ready
                          - search.finished
                        searchId:
                          type: string
                          format: uuid
                          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        companyId:
                          anyOf:
                          - type: string
                            format: uuid
                            pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          - type: 'null'
                        status:
                          type: string
                          enum:
                          - pending
                          - delivered
                          - failed
                          - skipped
                        attempts:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        lastStatus:
                          anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                        lastError:
                          type:
                          - string
                          - 'null'
                        createdAt:
                          type: string
                          format: date-time
                          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                        nextAttemptAt:
                          anyOf:
                          - type: string
                            format: date-time
                            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                          - type: 'null'
                        deliveredAt:
                          anyOf:
                          - type: string
                            format: date-time
                            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                          - type: 'null'
                      required:
                      - id
                      - event
                      - searchId
                      - companyId
                      - status
                      - attempts
                      - lastStatus
                      - lastError
                      - createdAt
                      - nextAttemptAt
                      - deliveredAt
                      additionalProperties: false
                required:
                - deliveries
                additionalProperties: false
        4XX:
          description: '`unauthorized`: No valid token. Send `Authorization: Bearer <key>`.


            `not_found`: No such search, company, email, drop, key or webhook on this account.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - unauthorized
          - claim_required
          - invalid_request
          - not_found
          - quota_exceeded
          - source_unavailable
          - not_cancelable
          - search_running
          - kind_mismatch
          - ongoing_not_supported
          - search_canceled
          - not_claimed
          - api_key_limit
          - account_exists
          - email_not_accepted
          - rate_limited
          - captcha_failed
          - busy
          - site_unreadable
          - ai_unavailable
          - ai_key_rejected
          - ai_model_unknown
          - search_key_rejected
          - signup_unavailable
          - too_many_drops
          - too_many_webhooks
          - webhook_url_not_allowed
          - database_unavailable
        details: {}
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key (nvk_sk_...) or an OAuth access token from nvoke’s Clerk.