> ## Documentation Index > Fetch the complete documentation index at: https://docs.userkit.dev/llms.txt > Use this file to discover all available pages before exploring further. # Register a webhook endpoint > Requires `webhooks:manage`. The endpoint is born in an environment and never leaves it: a test endpoint hears test traffic, a live one hears live traffic. Facts about the organization itself (`organization.created`, `member.invited`) carry no environment and go to the **live** endpoints — an organization has one real existence, and the test environment is where the customer plane is rehearsed, not where the organization is. The signing secret comes back here because this is the moment you need it, but unlike an API key it is re-showable: losing this response is not losing the secret. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/organization/webhooks openapi: 3.1.0 info: title: UserKit API version: 1.0.0 description: >- The HTTP surface of UserKit. Two planes share one API. The **staff plane** is what a human uses in the panel: users, organizations, roles, members, keys. The **customer plane** is what a developer's own product uses: contacts, identities, hosted or federated sign-in. Every error answers the same envelope — `{"error": {"code", "message"}}`. The `code` is a stable contract to branch on; the `message` is for a person and may change. servers: - url: '{baseUrl}' description: The API host. variables: baseUrl: default: https://api.userkit.dev description: Base URL of the API, no trailing slash. security: - sessionToken: [] tags: - name: Authentication description: >- Public sign-up, sign-in, two-factor and password recovery for staff accounts. - name: Session description: >- The active session: who the caller is, which organization they are in, and signing out. - name: Account description: The caller's own account — profile, password, sessions, avatar. - name: Two-factor description: >- TOTP setup, activation and recovery codes. Returns 501 when two-factor is unavailable on the server. - name: Organizations description: The organizations a user belongs to, and the active one. - name: Environments description: >- The live and test environments seeded with every organization, and their identity settings. - name: Members description: Memberships and invitations. - name: Roles description: Roles and the permission catalogue they draw from. - name: Audit log description: >- What staff did inside an organization. Append-only, and read behind its own permission. - name: API keys description: Secret keys (`uk_sk_…`) and publishable keys (`uk_pk_…`). - name: Contacts (staff session) description: >- The staff view of the customer plane, opened by a staff session. Reads take `?environment=` as an explicit view parameter. - name: Contacts (API key) description: >- The machine surface, authenticated by an API key. The environment is the key's environment and cannot be named by the caller. - name: Customer plane description: >- Called from the developer's own pages with a publishable key: boot, magic link, and the contact's own session. - name: Hosted auth description: >- Sign-up, sign-in, verification and recovery for contacts, when UserKit owns the account. - name: Customer teams description: >- A customer is a team. Its roster, its invitations and its two roles — owner and member — administered by the contact's own session. The active customer travels in `X-Customer-Id`. - name: Webhooks description: >- Outbound webhooks: endpoints, the published event catalogue, the delivery log, replay and test sends. Never gated by a plan — webhooks are a developer primitive. - name: Catalogue description: >- The plans, prices and features **you** sell to your own customers. Per environment, a price per currency, and `recurring` or `one_time`. Distinct from the plan you are on with UserKit, which is `GET /v1/organization/entitlements`. - name: Subscriptions description: >- What one of **your** customers is paying you, mirrored from the gateway that charges them. The gateway is the truth about money — it holds the schedule, runs the retries and decides what a proration is worth — so these routes ask it to change something and answer with what it then said. `provider_synced_at` is how stale the copy admits to being. - name: Provider webhooks description: >- Where a payment provider delivers to. Not a surface you call — it is a URL you paste into the provider's dashboard, which is why it sits outside `/v1`: a version bump must never mean editing a setting in somebody else's product. Signed with the secret of the connection named in the path, and safe to retry. - name: Entitlements description: >- What one of **your** customers may do, resolved: the plan their subscription carries, plus the overrides you promised them on top. This is the read your own gate calls, so it is cached and answers in one round trip. It is a different question from `GET /v1/organization/entitlements`, which is the plan **you** are on with UserKit — two catalogues, same word, different money. paths: /v1/organization/webhooks: post: tags: - Webhooks summary: Register a webhook endpoint description: >- Requires `webhooks:manage`. The endpoint is born in an environment and never leaves it: a test endpoint hears test traffic, a live one hears live traffic. Facts about the organization itself (`organization.created`, `member.invited`) carry no environment and go to the **live** endpoints — an organization has one real existence, and the test environment is where the customer plane is rehearsed, not where the organization is. The signing secret comes back here because this is the moment you need it, but unlike an API key it is re-showable: losing this response is not losing the secret. operationId: createWebhookEndpoint parameters: - $ref: '#/components/parameters/OrganizationHeader' requestBody: required: true content: application/json: schema: type: object required: - url - environment properties: url: type: string format: uri description: >- `https://` only. Deliveries never cross plaintext, and a redirect is refused rather than followed — register the final address. environment: type: string enum: - live - test description: type: string description: A label, so a list of three endpoints says which is which. subscribed_events: type: array items: type: string description: >- Types from `GET /v1/organization/webhooks/events`. Omit or leave empty for every deliverable event. example: url: https://api.example.com/userkit/webhooks environment: live description: Production subscribed_events: - contact.identified - contact.signed_in responses: '201': description: Created. `secret` is what deliveries are signed with. content: application/json: schema: allOf: - $ref: '#/components/schemas/WebhookEndpoint' - type: object properties: secret: type: string description: >- The signing secret (`uk_wh_…`). Re-showable at `/secret`. environment: type: string enum: - live - test '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: parameters: OrganizationHeader: name: X-Organization-Id in: header required: false schema: type: string description: >- The organization the caller is acting on — the `org_…` code that appears in the panel URL. It *identifies*; the membership JOIN is what *authorizes*, so a forged code reads nothing. Absent, the session's default organization answers. schemas: WebhookEndpoint: type: object properties: id: type: string format: uuid url: type: string format: uri description: Where deliveries are POSTed. `https://` only. description: type: string subscribed_events: type: array items: type: string description: >- Types from the published catalogue. **Empty means every deliverable event** — a new type then starts arriving without anything being changed here. status: type: string enum: - enabled - disabled description: >- `disabled` is either your decision or the auto-disable after sustained failure. A disabled endpoint is queued nothing. consecutive_failures: type: integer description: >- Deliveries that spent every attempt, back to back. Any success resets it. disabled_at: type: - string - 'null' format: date-time disabled_reason: type: string recent_failures: type: integer description: Deliveries that gave up in the last 24 hours. created_at: type: string format: date-time Error: type: object description: Every error in this API answers this envelope. properties: error: type: object properties: code: type: string description: Stable. Branch on this. message: type: string description: For a person. May change. required: - code - message required: - error example: error: code: forbidden message: your role does not allow this action responses: BadRequest: description: '`invalid_request` — the body or a parameter is malformed.' content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: >- `unauthorized` — missing, malformed or expired credential. A well-formed credential from the wrong family says so: "this endpoint expects a staff session token, not an organization API key". content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: '`forbidden` — your role does not allow this action.' content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: sessionToken: type: http scheme: bearer description: >- A staff session token, `uk_st_…`. Minted by sign-up, sign-in or the two-factor exchange. ````