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

# Fire a webhook.test event to your registered URL



## OpenAPI

````yaml /api-reference/openapi.json get /v1/webhooks/test
openapi: 3.1.0
info:
  title: DSS Public API
  description: >-
    Public OAuth 2.0 API for Digital Sea Service. See
    https://docs.digitalseaservice.com for the developer guide.
  version: 1.0.0
  contact:
    name: DSS Developer Support
    email: admin@digitalseaservice.com
    url: https://docs.digitalseaservice.com
  license:
    name: Proprietary
  termsOfService: https://digitalseaservice.com/terms
servers:
  - url: https://api.digitalseaservice.com
    description: Production
  - url: https://api.dev.digitalseaservice.com
    description: Sandbox (dev)
security: []
paths:
  /v1/webhooks/test:
    get:
      tags:
        - webhooks
      summary: Fire a webhook.test event to your registered URL
      operationId: fire_test_webhook_v1_webhooks_test_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResponse'
        '401':
          description: >-
            `invalid_token` — bearer token missing, malformed, expired, or
            revoked.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: '`partner_suspended` — the calling partner has been suspended.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: '`not_found` — the partner record backing the token was not found.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: >-
            `no_webhook_configured` — no webhook URL or signing secret is
            registered.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '500':
          description: >-
            `internal_error` — an unexpected error occurred; reference
            `instance`.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - bearerAuth: []
        - oauth2: []
components:
  schemas:
    TestResponse:
      properties:
        event_id:
          type: string
          title: Event Id
        delivery_id:
          type: string
          title: Delivery Id
        target_url:
          type: string
          title: Target Url
      type: object
      required:
        - event_id
        - delivery_id
        - target_url
      title: TestResponse
      description: Result of firing a ``webhook.test`` event.
      example:
        delivery_id: dlv_77f1bb31c0c64e6db4f5e8a9c2d3e4f5
        event_id: evt_3f4a9c8e2b1d4f5a8c9e0d1f2a3b4c5d
        target_url: https://yachtworkerscouncil.com/integrations/dss/webhook
    ProblemDetails:
      type: object
      description: >-
        RFC 7807 Problem Details. Returned with the `application/problem+json`
        content type on every resource (`/v1/*`) error.
      properties:
        type:
          type: string
          format: uri
          description: Stable URL identifying the error type; resolves to its docs page.
        title:
          type: string
          description: Short, human-readable summary of the error type.
        status:
          type: integer
          description: HTTP status code.
        detail:
          type: string
          description: Explanation specific to this occurrence.
        instance:
          type: string
          description: Request correlation id; matches the `X-Request-Id` header.
      required:
        - type
        - title
        - status
        - detail
        - instance
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
    oauth2:
      type: oauth2
      description: >-
        OAuth 2.0 Authorization Code flow with PKCE. See the integration guide
        at docs.digitalseaservice.com for the full step-by-step.
      flows:
        authorizationCode:
          authorizationUrl: https://api.digitalseaservice.com/oauth/authorize
          tokenUrl: https://api.digitalseaservice.com/oauth/token
          refreshUrl: https://api.digitalseaservice.com/oauth/token
          scopes:
            profile:read: Read the crew member's name, role, country, and photo URL.
            seatime:read: Read aggregate sea-time totals and the 12-month trend.
            vessels:read: Read the crew member's vessel history.

````