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

# Send a test message to a webhook for one of its subscribed topics

> Deliver a synthetic sample of one subscribed topic to the webhook and return the
delivery outcome, so a partner can verify their endpoint receives and accepts what a
real notification for that topic looks like. The topic must be one the webhook is
subscribed to (else 400); the sample is addressed straight to this webhook and never
fans out to the organization's other subscribers. A webhook that does not exist or
belongs to another organization is reported as not found.



## OpenAPI

````yaml https://app.podero.com/api/partners/v2.0/openapi.json post /api/partners/v2.0/org/{org_id}/notifications/webhooks/{webhook_id}/test
openapi: 3.1.0
info:
  title: Podero Partner API
  version: '2.0'
  description: >-
    This API provides a unified interaction point for Podero's partner
    companies.


    The goal of this API is to give partners easily integratable endpoints that
    don't require extensive software

    development. For this reason, the endpoints focus around user and device
    management, setting of preferences

    and high level device controls.


    While direct control of devices is implemented for special use cases such as
    pause power, we abstract away low level

    direct device steering so developers and partners can focus on delivering
    maximum value to end users.
  termsOfService: https://www.podero.com/terms-and-conditions
servers: []
security: []
paths:
  /api/partners/v2.0/org/{org_id}/notifications/webhooks/{webhook_id}/test:
    post:
      tags:
        - Notification Webhooks
      summary: Send a test message to a webhook for one of its subscribed topics
      description: >-
        Deliver a synthetic sample of one subscribed topic to the webhook and
        return the

        delivery outcome, so a partner can verify their endpoint receives and
        accepts what a

        real notification for that topic looks like. The topic must be one the
        webhook is

        subscribed to (else 400); the sample is addressed straight to this
        webhook and never

        fans out to the organization's other subscribers. A webhook that does
        not exist or

        belongs to another organization is reported as not found.
      operationId: >-
        integrations_api_api_v2_organizations_notifications_webhooks_router_test_webhook
      parameters:
        - in: path
          name: org_id
          schema:
            description: The organization ID of the user's organization
            format: uuid
            title: Org Id
            type: string
          required: true
          description: The organization ID of the user's organization
        - in: path
          name: webhook_id
          schema:
            description: The webhook ID
            format: uuid
            title: Webhook Id
            type: string
          required: true
          description: The webhook ID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookTestInput'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResultOutput'
      security:
        - OAuth2: []
components:
  schemas:
    WebhookTestInput:
      description: >-
        Send a test sample for one topic. The topic must be one the webhook is
        currently

        subscribed to.
      properties:
        topic:
          $ref: '#/components/schemas/Topic'
      required:
        - topic
      title: WebhookTestInput
      type: object
    WebhookTestResultOutput:
      description: >-
        The synchronous outcome of a test delivery. ``outcome`` is ``delivered``
        (with the

        endpoint's HTTP ``status_code``), ``failed`` (``detail`` carries the
        transport error),

        or ``cancelled`` (``detail`` says why, e.g. the webhook is disabled).
        The response is

        ``200`` for all three — the test *ran*; branch on ``outcome``, not the
        HTTP status.
      properties:
        topic:
          $ref: '#/components/schemas/Topic'
        schema_version:
          title: Schema Version
          type: integer
        outcome:
          title: Outcome
          type: string
        status_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Status Code
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      required:
        - topic
        - schema_version
        - outcome
      title: WebhookTestResultOutput
      type: object
    Topic:
      enum:
        - device.action_required
        - device.information
      title: Topic
      type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        password:
          tokenUrl: /api/partners/v2.0/auth/token
          scopes: {}
        clientCredentials:
          tokenUrl: /api/partners/v2.0/auth/token
          scopes: {}

````