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

# Create a webhook endpoint

> Register an HTTPS URL that receives signed event deliveries such as profile.updated.

The response includes the signing `secret` (a `whsec_...` value) once. Store it right away; later reads show a masked version. If you lose it, delete the endpoint and create a new one.

Deliveries are signed with HMAC-SHA256 — see [Events & signatures](/api/webhooks/events) for the payload and how to verify them.


## OpenAPI

````yaml openapi.json POST /v3/webhooks
openapi: 3.1.0
info:
  title: Orbit API
  version: 3.0.0
  description: Search for people and enrich known Orbit profiles.
servers:
  - url: https://api.orbitsearch.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Search
    description: Find people and poll search results.
  - name: Enrich
    description: Read or enrich known Orbit profiles.
  - name: Watchers
    description: Watch a profile on a schedule and read what each run found.
  - name: Webhooks
    description: Register endpoints that receive signed event deliveries.
paths:
  /v3/webhooks:
    post:
      tags:
        - Webhooks
      summary: Create a webhook endpoint
      description: >-
        Registers an HTTPS URL to receive signed event deliveries. The response
        includes the signing `secret` once. Requires the `webhooks:write` scope.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreateRequest'
            example:
              url: https://example.com/orbit/webhooks
              event_types:
                - profile.updated
      responses:
        '201':
          description: The endpoint, with its signing secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookCreateResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    WebhookCreateRequest:
      type: object
      required:
        - url
      properties:
        url:
          type: string
          format: uri
          description: >-
            A publicly reachable `https://` URL. Slack incoming-webhook URLs are
            accepted and receive a formatted message instead of the raw JSON
            payload.
        event_types:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
          description: Events to deliver. Omit to subscribe to all supported events.
        description:
          type: string
          description: Free-form label for your own bookkeeping.
    WebhookCreateResponse:
      allOf:
        - $ref: '#/components/schemas/WebhookEndpoint'
        - type: object
          required:
            - secret
            - supported_event_types
          properties:
            secret:
              type: string
              description: >-
                The signing secret (`whsec_...`). Shown once, at creation. Store
                it right away.
            supported_event_types:
              type: array
              items:
                $ref: '#/components/schemas/WebhookEventType'
    WebhookEventType:
      type: string
      enum:
        - profile.updated
        - company.thesis.changed
        - company.alert
        - portfolio.changed
    WebhookEndpoint:
      type: object
      required:
        - id
        - url
        - event_types
        - enabled
        - created_at
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
          description: >-
            The endpoint URL. Secret-bearing URLs (for example Slack incoming
            webhooks) are shown redacted.
        event_types:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
        enabled:
          type: boolean
        description:
          type:
            - string
            - 'null'
        secret_prefix:
          type: string
          description: First characters of the signing secret, for identification.
        secret_suffix:
          type: string
        last_delivery_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - status
        - error
      properties:
        status:
          type: string
          enum:
            - failed
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    BadRequest:
      description: The request is not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: The API key is missing or not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: The API key does not have the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: The API key exceeded a rate limit.
      headers:
        Retry-After:
          description: Seconds to wait before another request.
          schema:
            type: integer
            minimum: 0
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Orbit API key
      description: Use an Orbit API key from the developer dashboard.

````