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

# Create a subscription

> Create a topic-aware webhook subscription. Accepts the partner API key or the dashboard session cookie. The signing secret is shown exactly once. Order topics (`order.created`, `payment.cleared`, `signature.completed`, `shipment.delivered`) deliver only for orders you created through the Order API.



## OpenAPI

````yaml /api-reference/openapi.json post /api/partner/webhooks
openapi: 3.1.0
info:
  title: SignSealShip Partner API
  version: 1.0.0
  description: >-
    The SignSealShip partner API: create sign / notarize / ship orders, create
    Verified Closing Rooms, seal Closing Passports and Proof Passports, and
    manage webhooks. Partner endpoints authenticate with a bearer key
    (`Authorization: Bearer sss_pk_...`); public verification endpoints need no
    key — possession of the verify, room, or order code is the authorization.
    See the Guides for full prose, rate limits, and signature verification.
  contact:
    name: SignSealShip
    url: https://signsealship.com/partner
servers:
  - url: https://signsealship.com
    description: Production
security:
  - partnerKey: []
tags:
  - name: Onboarding
    description: Request partner API access.
  - name: Orders
    description: >-
      B2B order intake — create sign / notarize / ship orders, track them, and
      mint Stripe hosted checkout.
  - name: Sandbox
    description: >-
      Deterministic lifecycle simulation for TEST orders (sss_pk_test_ keys) —
      real state machine, real signed webhooks, no live money.
  - name: Launchpad & Analytics
    description: Your workspace's go-live checklist and tenant-scoped analytics.
  - name: Closing Rooms
    description: Verified Closing Rooms — one shareable page per transaction.
  - name: Closing Passports
    description: Room-level, hash-chained, KMS-sealed evidence manifests.
  - name: Proof Passport
    description: Seal and verify a single executed PDF.
  - name: Webhooks
    description: Signed event delivery and subscription management.
paths:
  /api/partner/webhooks:
    post:
      tags:
        - Webhooks
      summary: Create a subscription
      description: >-
        Create a topic-aware webhook subscription. Accepts the partner API key
        or the dashboard session cookie. The signing secret is shown exactly
        once. Order topics (`order.created`, `payment.cleared`,
        `signature.completed`, `shipment.delivered`) deliver only for orders you
        created through the Order API.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
            example:
              url: https://example.com/hooks/signsealship
              topics:
                - order.created
                - payment.cleared
                - room.passport_sealed
      responses:
        '200':
          description: Subscription created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Session not linked to a partner.
      security:
        - partnerKey: []
        - sessionCookie: []
components:
  schemas:
    CreateWebhookRequest:
      type: object
      required:
        - url
        - topics
      properties:
        url:
          type: string
          format: uri
          description: An absolute https:// URL.
        topics:
          type: array
          minItems: 1
          items:
            type: string
            enum:
              - passport.sealed
              - room.order_attached
              - room.passport_sealed
              - order.created
              - payment.cleared
              - signature.completed
              - shipment.delivered
              - trust.assessment_requested
              - trust.assessment_completed
              - trust.assessment_superseded
              - recording.review_required
              - recording.quote_ready
              - recording.approved
              - recording.fulfillment_queued
              - recording.mailed
              - recording.delivered_to_recorder
              - recording.accepted
              - recording.recorded
              - recording.rejected
              - recording.receipt_sealed
          description: >-
            The order topics deliver only for orders created through the Order
            API.
    CreateWebhookResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        secret:
          type: string
          description: Signing secret prefixed `sss_whsec_`. Shown exactly once.
        url:
          type: string
        topics:
          type: array
          items:
            type: string
        signatureHeader:
          type: string
          example: SignSealShip-Signature
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, malformed, revoked, or unknown partner key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: A valid partner API key is required.
  securitySchemes:
    partnerKey:
      type: http
      scheme: bearer
      bearerFormat: sss_pk_...
      description: 'Partner API key. Send as `Authorization: Bearer sss_pk_...`.'
    sessionCookie:
      type: apiKey
      in: cookie
      name: __Host-session
      description: >-
        SignSealShip dashboard login session cookie. Accepted by the
        `/api/partner/webhooks` management routes as an alternative to the
        partner key.

````