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

# Send a test event

> Sends a signed webhook.test event to your URL, so you can prove verification end to end.



## OpenAPI

````yaml /openapi.json post /webhook/test
openapi: 3.1.0
info:
  title: Signal Partner API
  description: >-
    Send Signal enquiries, viewings and listings from your system, and receive
    what Signal learns back as signed webhooks. Every call is in beta:
    documented ahead of going live, it answers `501 not_available_yet` until
    then.
  contact:
    name: Signal
    url: https://signalproptech.com/
  version: 1.0.0-beta
servers:
  - url: https://api.signalproptech.com/api/v1/partner
    description: Production
security: []
tags:
  - name: Enquiries
    description: >-
      Hand Signal an enquiry that started in your system, and read where it
      stands.
  - name: Viewings
    description: >-
      Tell Signal about viewings booked in your system, so it can remind and ask
      for feedback.
  - name: Listings and new homes
    description: >-
      Keep Signal's copy of your listings, developments, units and reservations
      up to date.
  - name: Webhooks
    description: >-
      Register where Signal sends events, test it, and catch up on what you
      missed.
  - name: Events
    description: >-
      What Signal sends to your webhook, one page per event type. Check the
      webhook- headers before trusting the body.
paths:
  /webhook/test:
    post:
      tags:
        - Webhooks
      summary: Send a test event
      description: >-
        Sends a signed webhook.test event to your URL, so you can prove
        verification end to end.
      operationId: send_test_event
      responses:
        '202':
          description: Sent. Watch for it at your URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestSent'
        '401':
          description: The key is missing, unknown or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: No webhook is registered for this agency.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limited. Retry after the number of seconds in `Retry-After`.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '501':
          description: Not live yet (beta).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
        - AgencyKey: []
components:
  schemas:
    WebhookTestSent:
      properties:
        event_id:
          type: string
          title: Event Id
          description: The webhook.test event's id, as it will arrive in webhook-id.
      type: object
      required:
        - event_id
      title: WebhookTestSent
      description: The test event we sent.
    ErrorBody:
      properties:
        error:
          type: string
          title: Error
          description: >-
            Stable machine code: validation_failed, unauthorized, bad_request,
            forbidden, not_found, method_not_allowed, conflict, too_large,
            unsupported_media_type, rate_limited, cursor_expired,
            not_available_yet or internal_error. Any other status gives error.
        message:
          type: string
          title: Message
          description: What went wrong, in plain English.
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Quote this to us and we can find the call.
        fields:
          items:
            $ref: '#/components/schemas/FieldError'
          type: array
          title: Fields
          description: Each problem with the request. Empty for other errors.
      type: object
      required:
        - error
        - message
      title: ErrorBody
      description: Every error has this shape.
    FieldError:
      properties:
        path:
          type: string
          title: Path
          description: >-
            Where the problem is, e.g. `contact.phone` or `house_types[0].name`.
            Empty for the request as a whole.
        code:
          type: string
          title: Code
          description: >-
            Stable code: required, empty, too_long, missing_offset, not_allowed,
            invalid_json or invalid.
        message:
          type: string
          title: Message
          description: What is wrong with this field, in plain English.
      type: object
      required:
        - path
        - code
        - message
      title: FieldError
      description: One problem with one field.
  securitySchemes:
    AgencyKey:
      type: http
      description: >-
        The agency's secret key, sent as `Authorization: Bearer <key>`. One key
        per agency.
      scheme: bearer

````

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