> ## Documentation Index
> Fetch the complete documentation index at: https://docs.intentleads.si/llms.txt
> Use this file to discover all available pages before exploring further.

# Change a webhook endpoint

> Send any of `url`, `events`, `description`, `enabled`, `rotate_secret`. Events you add start from now (nothing older is replayed). A new URL keeps the endpoint's place, so nothing is skipped or sent twice. With `rotate_secret`, the new secret comes back here.

**Admin key required.** Standard keys get `403 admin_key_required`.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/webhooks/{id}
openapi: 3.1.0
info:
  title: Intent Leads API
  version: '1.0'
  description: >-
    The Intent Leads API finds B2B people actively researching the topics you
    sell into, and exports them with contact details into your own tools.


    **Authentication.** Send an API key as a bearer token: `Authorization:
    Bearer il_live_…`. Standard keys work with everything except billing, team
    and key management, which need an admin key.


    **Organizations and workspaces.** An organization holds the balance,
    invoices and people; lanes, leads, exports, lists, websites and webhooks
    live in its workspaces. A workspace key works in its workspace. An
    organization key manages workspaces, billing and people, and works in any of
    its workspaces with the header `Intent-Leads-Workspace: <workspace id>`.


    **What costs money.** Only `POST /api/v1/exports` with `"dry_run": false`
    spends your [balance](/guides/billing) (and website visitors as they're
    identified). Quotes, counts, checks, estimates, samples and re-downloads are
    free.


    **Errors.** Every error is JSON: `{"error": "code", "message":
    "Plain-English explanation"}`. Codes are stable; messages may change.


    **Conventions.** JSON by default. Dates are `YYYY-MM-DD` and timestamps ISO
    8601, all in UTC. Lane codes (`L1`) are case-insensitive.
servers:
  - url: https://intentleads.si
security:
  - bearerAuth: []
tags:
  - name: Exports
    description: Quote (free) and buy new people from your lanes, then download them.
  - name: Leads
    description: Pull and re-download the leads you've exported, and list deliveries.
  - name: Lanes
    description: >-
      Create, inspect and tune lanes: keywords plus the companies and roles you
      want.
  - name: Topics
    description: >-
      Topics we already track: live at once, with history. Use them before
      adding new keywords.
  - name: Keywords
    description: >-
      Add and remove a lane's keywords: existing topics, or new ones approved as
      their own topic.
  - name: Checks
    description: >-
      Free lane checks that size every filter step over 14 days, plus quick
      topic signals.
  - name: Company list
    description: >-
      The target-company list your lanes can narrow to or use instead of
      industries.
  - name: Exclusions
    description: Companies and people left out of every lane, before anything is bought.
  - name: Suppressions
    description: >-
      People you exported who later asked to be removed, by API or pushed to
      your webhook.
  - name: Webhooks
    description: >-
      Endpoints that receive events as they happen (removals, website visitors),
      signed, each with its own events, tests and delivery log.
  - name: Websites
    description: Identify the people who visit your websites.
  - name: Billing
    description: >-
      Your prepaid balance, prices and cost estimates (any key); top-ups and the
      monthly top-up (admin keys).
  - name: Team
    description: Members and invite links. Admin keys only.
  - name: Workspaces
    description: >-
      One workspace per client, all paid from your balance, with an optional
      monthly budget each; hand one over to the client.
  - name: API keys
    description: Create, rename, rotate and revoke API keys. Admin keys only.
  - name: Account
    description: Check which organization a key belongs to, and rename it.
  - name: Reference
    description: Valid values for lane filters.
  - name: Activity
    description: A feed of changes and events in your organization.
paths:
  /api/v1/webhooks/{id}:
    patch:
      tags:
        - Webhooks
      summary: Change a webhook endpoint
      description: >-
        Send any of `url`, `events`, `description`, `enabled`, `rotate_secret`.
        Events you add start from now (nothing older is replayed). A new URL
        keeps the endpoint's place, so nothing is skipped or sent twice. With
        `rotate_secret`, the new secret comes back here.


        **Admin key required.** Standard keys get `403 admin_key_required`.
      operationId: updateWebhook
      parameters:
        - name: id
          in: path
          required: true
          description: The endpoint id.
          schema:
            type: string
            format: uuid
          example: 5b1d0a7e-3c2f-4e0b-9a51-2f6c8d7e9a10
        - $ref: '#/components/parameters/Workspace'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  description: A public https URL.
                events:
                  oneOf:
                    - type: string
                      enum:
                        - '*'
                      description: '`*`: every event, including types added later.'
                    - type: array
                      items:
                        type: string
                        enum:
                          - removals
                          - visitors
                      description: Only these events.
                description:
                  type:
                    - string
                    - 'null'
                  description: Up to 200 characters.
                enabled:
                  type: boolean
                rotate_secret:
                  type: boolean
              required:
                - url
                - events
                - description
                - enabled
                - rotate_secret
            example:
              events:
                - visitors
              enabled: true
      responses:
        '200':
          description: The endpoint.
          content:
            application/json:
              schema:
                type: object
                properties:
                  endpoint:
                    $ref: '#/components/schemas/WebhookEndpoint'
                  secret:
                    type: string
                    description: Only after rotate_secret.
                required:
                  - endpoint
                  - secret
              example:
                endpoint:
                  id: 5b1d0a7e-3c2f-4e0b-9a51-2f6c8d7e9a10
                  url: https://app.example.com/hooks/intent-leads
                  description: CRM sync
                  events:
                    - visitors
                  receives:
                    - visitors
                  enabled: true
                  status: ok
                  failed_attempts: 0
                  failing_since: null
                  next_retry_at: null
                  last_attempt_at: '2026-11-12T09:15:02.118Z'
                  last_status: 200
                  last_error: null
                  last_success_at: '2026-11-12T09:15:02.118Z'
                  waiting:
                    removals: 0
                  legacy: false
                  created_at: '2026-11-11T14:00:00.000Z'
                  updated_at: '2026-11-11T14:00:00.000Z'
        '400':
          description: Something in the body is wrong.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_url:
                  value:
                    error: invalid_url
                    message: url must start with https://.
                invalid_events:
                  value:
                    error: invalid_events
                    message: 'Unknown event: nope. Known: removals, visitors.'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AdminKeyRequired'
        '404':
          description: No such endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  value:
                    error: not_found
                    message: No webhook endpoint with that id.
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Workspace:
      name: Intent-Leads-Workspace
      in: header
      required: false
      description: >-
        Only with an **organization** key: the workspace to act in (its id;
        `?workspace=<id>` works too). Lanes, leads, exports, lists, websites and
        webhooks live in workspaces. Without it, an organization key acts in its
        only workspace, or gets `400 workspace_required` (with the list of
        workspaces) when it has several. Workspace keys don't need it. On keys,
        team and activity it switches from the organization's own to that
        workspace's.
      schema:
        type: string
        format: uuid
      example: 0a0e5135-a046-4f8c-8ca9-33de7cf9e54d
  schemas:
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
          description: Where we POST.
        description:
          type:
            - string
            - 'null'
        events:
          oneOf:
            - type: string
              enum:
                - '*'
              description: '`*`: every event, including types added later.'
            - type: array
              items:
                type: string
                enum:
                  - removals
                  - visitors
              description: Only these events.
        receives:
          type: array
          items:
            type: string
            enum:
              - removals
              - visitors
          description: The events it gets today.
        enabled:
          type: boolean
        status:
          type: string
          enum:
            - ok
            - failing
            - disabled
            - no_deliveries_yet
          description: '`failing` after a failed attempt, until one succeeds.'
        failed_attempts:
          type: integer
          description: >-
            Failed attempts in a row. We retry after 1, 2, 4, 8 minutes, then
            every hour.
        failing_since:
          type:
            - string
            - 'null'
          format: date-time
        next_retry_at:
          type:
            - string
            - 'null'
          format: date-time
        last_attempt_at:
          type:
            - string
            - 'null'
          format: date-time
        last_status:
          type:
            - integer
            - 'null'
          description: >-
            HTTP status your endpoint returned last time, or null if it didn't
            answer.
        last_error:
          type:
            - string
            - 'null'
        last_success_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Last delivery your endpoint accepted.
        waiting:
          type: object
          additionalProperties:
            type: integer
          description: Items waiting per event, where cheap to count (list and get only).
        legacy:
          type: boolean
          description: The endpoint behind the legacy single-webhook API.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - url
        - description
        - events
        - receives
        - enabled
        - status
        - failed_attempts
        - failing_since
        - next_retry_at
        - last_attempt_at
        - last_status
        - last_error
        - last_success_at
        - waiting
        - legacy
        - created_at
        - updated_at
    Error:
      type: object
      properties:
        error:
          type: string
          example: lane_not_found
          description: Stable machine-readable code, e.g. `lane_not_found`.
        message:
          type: string
          example: No lane L9.
          description: Plain-English explanation you can show to a person.
      required:
        - error
        - message
      description: Every error has this shape.
  responses:
    Unauthorized:
      description: Missing, malformed, unknown or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            unauthorized:
              value:
                error: unauthorized
                message: 'Send a valid API key as: Authorization: Bearer il_live_…'
    AdminKeyRequired:
      description: This endpoint needs an admin key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            admin_key_required:
              value:
                error: admin_key_required
                message: >-
                  This needs an admin API key. Owners create one under Settings
                  → API keys.
    InternalError:
      description: >-
        Unexpected server error. Safe to retry reads; retry an export only with
        the same `idempotency_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            internal_error:
              value:
                error: internal_error
                message: Something went wrong. Try again.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: il_live_…
      description: >-
        An Intent Leads API key, e.g. `il_live_` followed by 32 letters and
        digits. Create one on the API and CLI page of the dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.