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

# List your webhook endpoints

> Every endpoint you hold, in every state, with the ids of its signing keys. Secrets are not returned. Requires the `webhooks` scope.



## OpenAPI

````yaml /openapi.json get /v1/webhooks
openapi: 3.1.0
info:
  title: NoResponse API
  version: '1'
  description: >-
    The NoResponse API assesses a signup, login or purchase and answers with the
    account's one current risk: a 0 to 100 score, a decision for the flow
    (`allow`, `step_up`, `review` or `block`), the reasons behind it and the
    decision for each flow. The assessment's own facts, such as its status,
    confidence and incomplete sources, sit under `detail`.


    Authenticate every request with your API key as `Authorization: Bearer
    nrk_...`. Call the API only from your backend.


    Guides, SDKs and webhook verification are at
    [docs.noresponse.org](https://docs.noresponse.org/). Every error is an RFC
    9457 problem document; see
    [Errors](https://docs.noresponse.org/reference/errors).
servers:
  - url: https://api.noresponse.org
    description: Production
security:
  - tenantBearer: []
tags:
  - name: assess
    x-displayName: Assessments
    x-group: Assessments
    description: Create, read and list assessments, and report outcomes.
  - name: accounts
    x-displayName: Accounts
    x-group: Accounts
    description: >-
      Each of your accounts holds one current risk, and its assessments are its
      history.
  - name: usage
    x-displayName: Key usage
    x-group: Key usage
    description: >-
      Report usage of the API keys your signup gate issued, so a shared or
      stolen key raises its account's risk.
  - name: keys
    x-displayName: API keys
    x-group: API keys
    description: Rotate your own API key.
  - name: integrations
    x-displayName: Integrations
    x-group: Integrations
    description: >-
      Hosted endpoints that answer your WorkOS or Auth0 sign-up and sign-in
      hooks.
  - name: webhooks
    x-displayName: Webhooks
    x-group: Webhooks
    description: Your webhook endpoints, and the signed events NoResponse sends to them.
paths:
  /v1/webhooks:
    get:
      tags:
        - webhooks
      summary: List your webhook endpoints
      description: >-
        Every endpoint you hold, in every state, with the ids of its signing
        keys. Secrets are not returned. Requires the `webhooks` scope.
      operationId: listWebhookEndpoints
      responses:
        '200':
          $ref: '#/components/responses/WebhookEndpointList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/WorkspaceForbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - tenantBearer: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |
            curl --request GET \
              --url 'https://api.noresponse.org/v1/webhooks' \
              --header "Authorization: Bearer $NORESPONSE_API_KEY"
        - lang: typescript
          label: TypeScript
          source: |
            import { NoResponse } from "@noresponse/node";

            const noResponse = new NoResponse({
              apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
            });

            async function run() {
              const result = await noResponse.webhookEndpoints.list();

              console.log(result);
            }

            run();
        - lang: python
          label: Python
          source: |
            from noresponse import NoResponse
            import os


            with NoResponse(
                api_key=os.getenv("NORESPONSE_API_KEY", ""),
            ) as no_response:

                res = no_response.webhook_endpoints.list()

                # Handle response
                print(res)
        - lang: go
          label: Go
          source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tnoresponse \"github.com/noresponsehq/go/v5\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := noresponse.New(\n        noresponse.WithSecurity(os.Getenv(\"NORESPONSE_API_KEY\")),\n    )\n\n    res, err := s.WebhookEndpoints.List(ctx)\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res != nil {\n        // handle response\n    }\n}\n"
        - lang: java
          label: Java
          source: >
            package hello.world;


            import java.lang.Exception;

            import org.noresponse.NoResponse;

            import org.noresponse.models.errors.AuthenticationException;

            import org.noresponse.models.errors.BadRequestException;

            import org.noresponse.models.errors.ConflictException;

            import org.noresponse.models.errors.NotFoundException;

            import org.noresponse.models.errors.PermissionDeniedException;

            import org.noresponse.models.errors.RateLimitException;

            import
            org.noresponse.models.operations.ListWebhookEndpointsResponse;


            public class Application {

                public static void main(String[] args) throws Exception {

                    NoResponse sdk = NoResponse.builder()
                            .apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
                        .build();

                    ListWebhookEndpointsResponse res = sdk.webhookEndpoints().list()
                            .call();

                    if (res.webhookEndpointList().isPresent()) {
                        System.out.println(res.webhookEndpointList().get());
                    }
                }
            }
        - lang: csharp
          label: C#
          source: >
            using NoResponse;

            using NoResponse.Models.Shared;

            using System;


            var sdk = new NoResponseClient(apiKey:
            Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));


            var res = await sdk.WebhookEndpoints.ListAsync();


            // handle response
        - lang: php
          label: PHP
          source: |
            <?php

            declare(strict_types=1);

            require 'vendor/autoload.php';

            use NoResponse;

            $sdk = NoResponse\NoResponseClient::builder()
                ->setSecurity(
                    getenv('NORESPONSE_API_KEY') ?: ''
                )
                ->build();



            $response = $sdk->webhookEndpoints->list(

            );

            if ($response->webhookEndpointList !== null) {
                // handle response
            }
        - lang: ruby
          label: Ruby
          source: |
            require 'noresponse'

            Models = ::NoResponse::Models
            s = ::NoResponse::NoResponseClient.new(
              api_key: ENV.fetch('NORESPONSE_API_KEY', '')
            )
            res = s.webhook_endpoints.list

            unless res.nil?
              # handle response
            end
components:
  responses:
    WebhookEndpointList:
      description: Every endpoint of the calling workspace.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WebhookEndpointList'
          examples:
            endpoints:
              value:
                items:
                  - endpoint_id: whe_01JA2ZD0E1F2G3H4J5K6M7N8P9
                    url: https://hooks.example.com/noresponse
                    state: verified
                    response_mode: standard
                    created_at: '2026-10-22T09:00:00.000Z'
                    verified_at: '2026-10-22T09:00:05.000Z'
                    signing_keys:
                      - key_id: whk_01JA2Z9A1B2C3D4E5F6G7H8J9K
                        created_at: '2026-10-22T09:00:00.000Z'
                        expires_at: '2026-10-29T10:00:00.000Z'
                      - key_id: whk_01JA2ZD1M2N3P4Q5R6S7T8V9W0
                        created_at: '2026-10-22T10:00:00.000Z'
    Unauthorized:
      description: No API key, or one that is malformed, unknown, revoked or expired.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        WWW-Authenticate:
          schema:
            type: string
            const: Bearer realm="noresponse-assessments"
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 401
                  code:
                    enum:
                      - unauthorized
    WorkspaceForbidden:
      description: >-
        The API key is valid but may not use this operation: it lacks the
        operation's scope, or its workspace is not entitled or is suspended.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 403
                  code:
                    enum:
                      - workspace_forbidden
          examples:
            missingScope:
              value:
                type: https://docs.noresponse.org/problems/workspace-forbidden
                title: Forbidden
                status: 403
                detail: The API key does not carry a scope this operation accepts.
                code: workspace_forbidden
                request_id: 0123456789abcdef0123456789abcdef
    RateLimited:
      description: >-
        The workspace's rate or concurrency limit is exhausted. Retry-After says
        when to retry; the provider applies its own fallback meanwhile.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        Retry-After:
          description: >-
            Whole seconds to wait before polling or retrying. Required on 202,
            429 and 503.
          schema:
            type: string
            pattern: >-
              ^(?:[1-9]|[1-9][0-9]|[1-9][0-9]{2}|[12][0-9]{3}|3[0-5][0-9]{2}|3600)$
            description: Whole decimal seconds; wait at least this long.
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 429
                  code:
                    enum:
                      - rate_limited
          examples:
            limited:
              value:
                type: https://docs.noresponse.org/problems/rate-limited
                title: Rate limited
                status: 429
                detail: >-
                  The tenant's assessment rate is exhausted; retry after the
                  Retry-After interval.
                code: rate_limited
                request_id: 0123456789abcdef0123456789abcdef
    ServiceUnavailable:
      description: >-
        The assessment could not be admitted at all (overload, shutdown or a
        dependency down). An assessment that was admitted answers partial or
        pending instead of 503.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
          required: true
        Retry-After:
          description: >-
            Whole seconds to wait before polling or retrying. Required on 202,
            429 and 503.
          schema:
            type: string
            pattern: >-
              ^(?:[1-9]|[1-9][0-9]|[1-9][0-9]{2}|[12][0-9]{3}|3[0-5][0-9]{2}|3600)$
            description: Whole decimal seconds; wait at least this long.
          required: true
        X-Request-ID:
          description: The request correlation id, 32 lowercase hexadecimal characters.
          schema:
            type: string
            pattern: ^[0-9a-f]{32}$
            not:
              pattern: \n
          required: true
      content:
        application/problem+json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Problem'
              - properties:
                  status:
                    const: 503
                  code:
                    enum:
                      - service_unavailable
  schemas:
    WebhookEndpointList:
      title: Webhook endpoint list
      description: >-
        GET /v1/webhooks answer: every endpoint of the calling workspace, in
        every state, ordered by endpoint_id. A workspace holds at most 5, so
        there is no page.
      type: object
      additionalProperties: false
      required:
        - items
      properties:
        items:
          type: array
          maxItems: 5
          items:
            title: Webhook endpoint
            description: >-
              One of the workspace's registered webhook endpoints. Signing
              secrets are not part of it: a secret is shown once, when it is
              issued (POST /v1/webhooks and POST
              /v1/webhooks/{endpoint_id}/rotate).
            type: object
            additionalProperties: false
            required:
              - endpoint_id
              - url
              - state
              - response_mode
              - created_at
              - signing_keys
            properties:
              endpoint_id:
                type: string
                pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$
                not:
                  description: >-
                    A line feed anywhere, refused with `not` beside every
                    anchored pattern.
                  pattern: \n
                description: Opaque id of the endpoint registration.
              url:
                type: string
                minLength: 12
                maxLength: 2048
                description: The destination URL, as registered.
              state:
                enum:
                  - unverified
                  - verified
                  - disabled
                description: >-
                  unverified until the endpoint echoes an endpoint.verification
                  challenge (send one with POST
                  /v1/webhooks/{endpoint_id}/test); verified receives
                  assessment.updated events; disabled after 72 hours of
                  continuous delivery failure, and verified again by the same
                  challenge.
              response_mode:
                enum:
                  - standard
                  - detailed
                description: >-
                  The view assessment.updated events carry: the assessment as
                  GET /v1/assessments/{assessment_id} returns it in this
                  response mode.
              created_at:
                type: string
                format: date-time
              verified_at:
                type: string
                format: date-time
                description: >-
                  When the endpoint last echoed a challenge. Absent until it
                  first does.
              signing_keys:
                type: array
                minItems: 1
                maxItems: 64
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - key_id
                    - created_at
                  description: One signing key, by id. The secret is not included.
                  properties:
                    key_id:
                      type: string
                      pattern: ^whk_[A-Za-z0-9]{8,64}$
                      description: >-
                        The signing key id, sent as NR-Webhook-Key-Id on every
                        delivery it signs.
                    created_at:
                      type: string
                      format: date-time
                    expires_at:
                      type: string
                      format: date-time
                      description: >-
                        Present on a key a rotation replaced: it stops verifying
                        at this instant, 7 days after the rotation. Absent on
                        the key that signs.
                description: >-
                  The keys a receiver may see in NR-Webhook-Key-Id, oldest
                  first. The last one signs every new delivery; an older one
                  keeps verifying until its expires_at.
            $defs:
              endpoint_id:
                type: string
                pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$
                not:
                  description: >-
                    A line feed anywhere, refused with `not` beside every
                    anchored pattern.
                  pattern: \n
                description: Opaque id of the endpoint registration.
              key_id:
                type: string
                pattern: ^whk_[A-Za-z0-9]{8,64}$
                description: >-
                  The signing key id, sent as NR-Webhook-Key-Id on every
                  delivery it signs.
              signing_key:
                type: object
                additionalProperties: false
                required:
                  - key_id
                  - created_at
                description: One signing key, by id. The secret is not included.
                properties:
                  key_id:
                    type: string
                    pattern: ^whk_[A-Za-z0-9]{8,64}$
                    description: >-
                      The signing key id, sent as NR-Webhook-Key-Id on every
                      delivery it signs.
                  created_at:
                    type: string
                    format: date-time
                  expires_at:
                    type: string
                    format: date-time
                    description: >-
                      Present on a key a rotation replaced: it stops verifying
                      at this instant, 7 days after the rotation. Absent on the
                      key that signs.
              signing_secret:
                type: object
                additionalProperties: false
                required:
                  - key_id
                  - secret
                  - created_at
                description: >-
                  A newly issued signing key with its secret, shown only in this
                  answer. A receiver verifies NR-Webhook-Signature with the
                  secret's UTF-8 bytes as the HMAC-SHA256 key.
                properties:
                  key_id:
                    type: string
                    pattern: ^whk_[A-Za-z0-9]{8,64}$
                    description: >-
                      The signing key id, sent as NR-Webhook-Key-Id on every
                      delivery it signs.
                  secret:
                    type: string
                    pattern: ^[A-Za-z0-9_-]{43}$
                    description: >-
                      The signing secret: 32 random bytes as 43 characters of
                      unpadded base64url. It is not stored in readable form or
                      returned again.
                  created_at:
                    type: string
                    format: date-time
    Problem:
      title: Problem details error
      description: >-
        RFC 9457 problem-details error body returned by every non-2xx API
        response, extended with a stable machine code and request id.
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri-reference
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        instance:
          type: string
          format: uri-reference
        code:
          type: string
        request_id:
          type: string
          minLength: 1
        invalid_params:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - field
              - reason
            properties:
              field:
                type: string
                minLength: 1
              reason:
                type: string
                minLength: 1
              example:
                type: string
                minLength: 1
  securitySchemes:
    tenantBearer:
      type: http
      scheme: bearer
      description: >-
        Your API key, sent as `Authorization: Bearer <key>`. A key is
        `nrk_live_` or `nrk_test_`, a 26-character key id, `_` and a
        43-character secret. A key sees only its own environment's data.


        Each key has one or more scopes: `assess` creates and reads assessments,
        records outcomes and reports key usage; `history` reads assessments, an
        account's current risk and an account's history, and erases an account;
        `detailed` adds the detailed view; `webhooks` registers, tests, rotates
        and deletes webhook endpoints; `integrations` registers and manages
        hosted provider integrations. A missing, unknown, revoked or expired key
        answers 401. A valid key without the scope an operation needs answers
        403.

````

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