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

# Create a webhook

> Maximum 10 active endpoints. HTTPS port 443 and public addresses only. Signing secret is encrypted at rest. Same key/body replays creation; different body returns 409.

## TypeScript

```ts theme={null}
import { ReviseClient } from "@reviseio/api";

const revise = new ReviseClient({ apiKey: process.env.REVISE_API_KEY! });
const result = await revise.webhooks.create({ url: "https://example.com/hooks/revise", events: ["prompt.completed", "conversion.completed"] }, { idempotencyKey: "webhook-42" });
```


## OpenAPI

````yaml openapi/revise-api.json POST /v1/webhooks
openapi: 3.1.0
info:
  title: Revise API
  version: 0.1.0
  description: >-
    Queued document prompting and file conversion. Conversion supports the same
    formats as revise.io/converter, including semantic PDF/image scanning. USD
    responses are exact decimal strings. Same-origin downloads require Bearer
    auth. Account provider keys (BYOK) are pinned at admission. Request content
    expires 24 hours after terminal completion; encrypted artifacts use compact
    JWE RSA-OAEP-256/A256GCM.
servers:
  - url: https://revise.io/api
security:
  - apiKey: []
paths:
  /v1/webhooks:
    post:
      summary: Register an HTTPS webhook endpoint
      description: >-
        Maximum 10 active endpoints. HTTPS port 443 and public addresses only.
        Signing secret is encrypted at rest. Same key/body replays creation;
        different body returns 409.
      operationId: createWebhook
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                url:
                  type: string
                  format: uri
                  example: https://app.example.com/hooks/revise
                events:
                  type: array
                  minItems: 1
                  maxItems: 7
                  uniqueItems: true
                  items:
                    type: string
                    enum:
                      - prompt.completed
                      - prompt.failed
                      - prompt.cancelled
                      - prompt.paused
                      - conversion.completed
                      - conversion.failed
                      - conversion.cancelled
              required:
                - url
                - events
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Webhook:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          example: wh_21ff52db-63f9-4a1c-a1ab-8d1a9f11c201
        url:
          type: string
          format: uri
          example: https://example.com/webhooks/revise
        events:
          type: array
          minItems: 1
          maxItems: 7
          uniqueItems: true
          items:
            type: string
            enum:
              - prompt.completed
              - prompt.failed
              - prompt.cancelled
              - prompt.paused
              - conversion.completed
              - conversion.failed
              - conversion.cancelled
          example:
            - prompt.completed
            - prompt.failed
        created_at:
          type: string
          format: date-time
          example: '2026-09-08T12:00:00Z'
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
          example: null
        signing_secret:
          type: string
          description: Returned only on creation and its idempotent replay. Store securely.
          example: whsec_AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8=
      required:
        - id
        - url
        - events
        - created_at
        - deleted_at
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Revise API key from https://revise.io/console/api-keys. Send
        Authorization: Bearer <key>.

````