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

# Send test event

> Sends a `ping` event to this endpoint only, whatever it subscribes to, so you can
check the URL and your signature verification. Queued like any delivery; its outcome
appears in the deliveries list.




## OpenAPI

````yaml /api-reference/openapi.yaml post /webhook_endpoints/{uuid}/test
openapi: 3.0.3
info:
  title: Streamlined API
  description: >
    Access customers, customer applications, customer groups, products, payouts,
    invoices, transactions, and deposit links programmatically through this API,
    and receive webhooks when deposit links change. All requests must be
    authenticated with an API key.
  version: 1.6.0
  license:
    name: Proprietary
    url: https://streamlinedpayments.com/terms
servers:
  - url: https://api.staging.streamlinedpayments.com/api/v1
    description: Sandbox
  - url: https://api.streamlinedpayments.com/api/v1
    description: Production
security:
  - AppIdAuth: []
    ApiKeyAuth: []
tags:
  - name: Customers
    description: Create, update and delete the businesses you sell to.
  - name: Customer applications
    description: >-
      List the applications your customers submit, and approve them. Approving
      can also set net terms and export the customer to Shopify. See [Approve
      customer applications](/guides/customer-applications).
  - name: Customer groups
    description: >-
      Organize customers into groups and manage who's in each one. A group can
      be linked to a Shopify B2B company.
  - name: Customer files
    description: Upload and manage files attached to a customer.
  - name: Customer addresses
    description: Manage a customer's addresses and choose their default billing address.
  - name: Orders
    description: Create orders, add and remove line items, and schedule them.
  - name: Invoices
    description: Create invoices from orders, then list, look up and update them.
  - name: Transactions
    description: List transactions and look one up.
  - name: Payouts
    description: List payouts, including pending ones, and look one up.
  - name: Products
    description: >-
      Create and update the products and services you sell, import them in bulk,
      and merge duplicates.
  - name: Deposit links
    description: Collect money from a customer before an invoice exists.
  - name: Webhooks
    description: >-
      Register HTTPS endpoints to receive events when something changes. See
      [Webhooks](/guides/webhooks) for signatures, retries and delivery
      guarantees.
paths:
  /webhook_endpoints/{uuid}/test:
    post:
      tags:
        - Webhooks
      summary: Send test event
      description: >
        Sends a `ping` event to this endpoint only, whatever it subscribes to,
        so you can

        check the URL and your signature verification. Queued like any delivery;
        its outcome

        appears in the deliveries list.
      operationId: testWebhookEndpoint
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '202':
          description: Queued.
          content:
            application/json:
              schema:
                type: object
                properties:
                  delivery:
                    $ref: '#/components/schemas/WebhookDelivery'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: The endpoint is disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: endpoint_disabled
                message: Enable the endpoint before testing it.
components:
  schemas:
    WebhookDelivery:
      type: object
      properties:
        uuid:
          type: string
          description: Also sent as the Streamlined-Delivery-Id header.
        event_id:
          type: string
          description: The event's id, also its Streamlined-Event-Id header.
        event_type:
          type: string
        status:
          type: string
          enum:
            - pending
            - succeeded
            - failed
          description: >
            `pending` is not delivered yet, and retrying if `attempts` is above
            zero.

            `failed` gave up after every retry, or the endpoint was switched off
            first.
        attempts:
          type: integer
        response_status:
          type: integer
          nullable: true
          description: The HTTP status of the latest attempt. Null if we could not connect.
        error:
          type: string
          nullable: true
          description: >-
            Why the latest attempt could not connect, or why we refused to. Null
            when there was a response.
        last_attempted_at:
          type: string
          format: date-time
          nullable: true
        next_attempt_at:
          type: string
          format: date-time
          nullable: true
        delivered_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            AuthenticationRequired:
              value:
                error: Authentication required
                message: >-
                  API endpoint requires authentication. Please provide valid
                  X-App-Id and X-Api-Key headers.
            InvalidCredentials:
              value:
                error: Invalid credentials
                message: >-
                  The provided API credentials are invalid. Please check your
                  X-App-Id and X-Api-Key values.
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    AppIdAuth:
      type: apiKey
      in: header
      name: X-App-Id
      description: App ID for authentication
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API Key for authentication

````

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