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

# Update Webhook

> Update any subset of a webhook's fields. Set rotate_secret to true to mint a new signing secret — the response then includes the full new secret (shown only on rotation) and the previous secret immediately stops verifying. Set active to true to re-enable a previously deleted webhook. Free (0 credits).



## OpenAPI

````yaml PUT /webhooks/{id}
openapi: 3.1.0
info:
  title: Signalbase API
  description: >-
    Complete Signalbase V2 API: signal endpoints (funding, acquisitions, job
    changes, hiring, investors), companies, people, CSV enrichment, webhooks,
    and monitoring. Generated from the per-page specs under
    api-reference/*/openapi.json (run scripts/build-openapi.mjs).
  version: 2.4.0
servers:
  - url: https://www.trysignalbase.com/api/v2
security:
  - bearerAuth: []
paths:
  /webhooks/{id}:
    put:
      summary: Update Webhook
      description: >-
        Update any subset of a webhook's fields. Set rotate_secret to true to
        mint a new signing secret — the response then includes the full new
        secret (shown only on rotation) and the previous secret immediately
        stops verifying. Set active to true to re-enable a previously deleted
        webhook. Free (0 credits).
      operationId: updateWebhook
      parameters:
        - $ref: '#/components/parameters/Webhook_WebhookId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Webhook_WebhookUpdateRequest'
            examples:
              changeEvents:
                summary: Change subscribed events and pause
                value:
                  event_types:
                    - funding.created
                  active: false
              rotateSecret:
                summary: Rotate the signing secret
                value:
                  rotate_secret: true
      responses:
        '200':
          description: >-
            The updated webhook. Includes the full secret only when
            rotate_secret was true; otherwise secret_preview.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook_WebhookUpdateResponse'
              examples:
                updated:
                  summary: Fields updated (no rotation)
                  value:
                    success: true
                    data:
                      id: b1f2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                      endpoint_url: https://example.com/hooks/signalbase
                      event_types:
                        - funding.created
                      filters:
                        countries: US,GB
                      active: false
                      created_at: '2026-05-29T10:30:00.000Z'
                      updated_at: '2026-05-29T13:00:00.000Z'
                      last_modified_by: user_2a9f8c7b6d5e4f3a
                      last_modified_via: api
                      secret_preview: …5a6b
                      stats:
                        total_deliveries: 42
                        successful_deliveries: 40
                        failed_deliveries: 2
                        last_success_at: '2026-05-29T12:00:00.000Z'
                        last_failure_at: '2026-05-28T09:00:00.000Z'
                        consecutive_failures: 0
                    meta:
                      endpoint: webhooks.update
                      creditsUsed: 0
                rotated:
                  summary: Secret rotated (full secret returned once)
                  value:
                    success: true
                    data:
                      id: b1f2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                      endpoint_url: https://example.com/hooks/signalbase
                      event_types:
                        - funding.created
                        - hiring.created
                      filters:
                        countries: US,GB
                      active: true
                      created_at: '2026-05-29T10:30:00.000Z'
                      updated_at: '2026-05-29T13:05:00.000Z'
                      last_modified_by: user_2a9f8c7b6d5e4f3a
                      last_modified_via: api
                      secret: 7d2e9b1a-4c6f-4d8e-9a0b-1c2d3e4f5061
                      stats:
                        total_deliveries: 42
                        successful_deliveries: 40
                        failed_deliveries: 2
                        last_success_at: '2026-05-29T12:00:00.000Z'
                        last_failure_at: '2026-05-28T09:00:00.000Z'
                        consecutive_failures: 0
                    meta:
                      endpoint: webhooks.update
                      creditsUsed: 0
        '400':
          $ref: '#/components/responses/Webhook_BadRequest'
        '401':
          $ref: '#/components/responses/Webhook_Unauthorized'
        '403':
          $ref: '#/components/responses/Webhook_SubscriptionExpired'
        '404':
          $ref: '#/components/responses/Webhook_NotFound'
        '409':
          $ref: '#/components/responses/Webhook_MonitorOwned'
        '429':
          $ref: '#/components/responses/Webhook_RateLimited'
        '500':
          $ref: '#/components/responses/Webhook_InternalError'
components:
  parameters:
    Webhook_WebhookId:
      name: id
      in: path
      required: true
      description: The webhook subscription ID.
      schema:
        type: string
  schemas:
    Webhook_WebhookUpdateRequest:
      type: object
      description: >-
        Send any subset of fields. Field names accept snake_case or camelCase
        (endpointUrl, eventTypes, rotateSecret).
      properties:
        endpoint_url:
          type: string
          format: uri
          maxLength: 500
          description: New destination URL. Same validation as create.
        event_types:
          type: array
          description: Replacement list of subscribed event types.
          items:
            $ref: '#/components/schemas/Webhook_EventType'
        filters:
          type: object
          description: >-
            Replacement filter map. Same recognized keys as on create
            (countries, categories, search, teamSize, dateFrom, dateTo, funding,
            roundFlavor, fundingAmount, acquisitionAmount, healthScore);
            unrecognized keys are ignored.
          additionalProperties:
            type: string
        active:
          type: boolean
          description: Set false to pause, or true to re-enable a soft-deleted webhook.
        rotate_secret:
          type: boolean
          description: >-
            If true, generate a new signing secret. The response includes the
            full new secret once; the old secret stops verifying immediately.
    Webhook_WebhookUpdateResponse:
      type: object
      required:
        - success
        - data
        - meta
      properties:
        success:
          type: boolean
          const: true
        data:
          $ref: '#/components/schemas/Webhook_Webhook'
        meta:
          $ref: '#/components/schemas/Webhook_ResponseMeta'
    Webhook_EventType:
      type: string
      description: >-
        Event type a subscription can register for. system.test is accepted but
        only ever delivered by the Send Test Event endpoint; it never fires
        automatically.
      enum:
        - funding.created
        - acquisition.created
        - job_change.created
        - hiring.created
        - new_company.created
        - investor.created
        - system.test
    Webhook_Webhook:
      type: object
      description: >-
        A webhook subscription. List/retrieve/update(no rotation)/delete include
        secret_preview; create and rotate_secret include the full secret
        instead.
      required:
        - id
        - endpoint_url
        - event_types
        - filters
        - active
        - created_at
        - updated_at
        - last_modified_by
        - last_modified_via
        - stats
      properties:
        id:
          type: string
          description: Unique webhook ID (UUID).
        endpoint_url:
          type: string
          format: uri
          description: HTTPS endpoint that receives deliveries.
        event_types:
          type: array
          description: Event types this subscription is registered for.
          items:
            $ref: '#/components/schemas/Webhook_EventType'
        filters:
          type: object
          description: >-
            Optional string key/value filters that narrow which events are
            delivered. Recognized keys: countries, jobCountries, categories,
            search, teamSize, dateFrom, dateTo, funding, roundFlavor,
            fundingAmount, acquisitionAmount, healthScore. Unrecognized keys are
            silently ignored — note the round-type key is `funding`, not
            `round`. For hiring.created events `countries` matches the job
            listing country OR the company HQ country (same as the REST hiring
            endpoint), and `jobCountries` matches the job listing country only;
            `jobCountries` never matches non-hiring events. For investor.created
            events only countries and search apply. See the Webhooks overview
            'Filters' section for value formats.
          additionalProperties:
            type: string
        active:
          type: boolean
          description: >-
            Whether the webhook is active. Soft-deleted webhooks are
            active=false.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        last_modified_by:
          type:
            - string
            - 'null'
          description: >-
            ID of the user who last modified the webhook. Null if created before
            audit columns existed.
        last_modified_via:
          type:
            - string
            - 'null'
          description: Where the last change originated.
          enum:
            - api
            - dashboard
            - null
        secret:
          type: string
          description: >-
            Full HMAC signing secret (UUID). Returned ONLY on create and on
            update with rotate_secret:true.
        secret_preview:
          type: string
          description: >-
            An ellipsis followed by the last 4 characters of the secret (e.g.
            "…5a6b"). Returned on every read instead of the full secret.
        stats:
          $ref: '#/components/schemas/Webhook_WebhookStats'
    Webhook_ResponseMeta:
      type: object
      required:
        - endpoint
        - creditsUsed
      properties:
        endpoint:
          type: string
          description: Endpoint identifier (e.g. webhooks.create).
        creditsUsed:
          type: integer
          minimum: 0
          description: API credits consumed by this request.
    Webhook_ErrorResponse:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          enum:
            - bad_request
            - invalid_api_key
            - subscription_expired
            - not_found
            - conflict
            - rate_limited
            - internal_server_error
            - internal_error
        retryAfter:
          type: integer
          description: >-
            Seconds until a retry is recommended. Present on rate-limit (429)
            responses.
    Webhook_WebhookStats:
      type: object
      required:
        - total_deliveries
        - successful_deliveries
        - failed_deliveries
        - last_success_at
        - last_failure_at
        - consecutive_failures
      properties:
        total_deliveries:
          type: integer
          minimum: 0
        successful_deliveries:
          type: integer
          minimum: 0
        failed_deliveries:
          type: integer
          minimum: 0
        last_success_at:
          type:
            - string
            - 'null'
          format: date-time
        last_failure_at:
          type:
            - string
            - 'null'
          format: date-time
        consecutive_failures:
          type: integer
          minimum: 0
  responses:
    Webhook_BadRequest:
      description: >-
        Invalid request body, invalid endpoint URL, invalid event type, or the
        per-team active webhook limit (10) was reached.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Webhook_ErrorResponse'
          example:
            success: false
            error: Webhook URL must be a public address
            code: bad_request
    Webhook_Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Webhook_ErrorResponse'
          example:
            success: false
            error: Invalid API key. No key found.
            code: invalid_api_key
    Webhook_SubscriptionExpired:
      description: The API key belongs to a team without an active subscription.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Webhook_ErrorResponse'
          example:
            success: false
            error: >-
              Subscription expired. Please upgrade your subscription:
              https://www.trysignalbase.com/#pricing
            code: subscription_expired
    Webhook_NotFound:
      description: No webhook (or delivery) with that ID exists for the authenticated team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Webhook_ErrorResponse'
          example:
            success: false
            error: Webhook not found
            code: not_found
    Webhook_MonitorOwned:
      description: >-
        The webhook belongs to a monitor. Its endpoint, event types, filters,
        and active state are managed through the Monitoring API (Update
        Monitor); only rotate_secret is accepted here.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Webhook_ErrorResponse'
          example:
            success: false
            error: >-
              This webhook belongs to monitor
              29681a72-ed3d-41a8-b119-2c2942b34996 and can't be edited here. Use
              PUT /api/v2/monitors/29681a72-ed3d-41a8-b119-2c2942b34996
              (signal_types, active, webhook_url) or the Monitoring page
              instead.
            code: conflict
    Webhook_RateLimited:
      description: >-
        Rate limit exceeded for this team and endpoint. The response also sets
        X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Webhook_ErrorResponse'
          example:
            success: false
            error: Too many requests. Please upgrade your plan or slow down.
            code: rate_limited
            retryAfter: 60
    Webhook_InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Webhook_ErrorResponse'
          example:
            success: false
            error: An unknown error occurred
            code: internal_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Use your `ff_live_…` API key as a Bearer token in the Authorization
        header.

````

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