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

> Send a simulated test event to your webhook URL. Use this to verify your handler is correctly receiving and processing webhook payloads before going live.

# Simulate webhook event



## OpenAPI

````yaml post /v1/webhooks/{webhookId}/simulate
openapi: 3.0.0
info:
  title: Partner API
  description: Public API for partner integrations
  version: '1.0'
  contact: {}
servers:
  - url: https://api-staging.respondent.io
security: []
tags: []
paths:
  /v1/webhooks/{webhookId}/simulate:
    post:
      tags:
        - webhooks
      summary: Simulate webhook event
      description: >-
        Making a request to this endpoint will trigger a test webhook for the
        specified event.

        This can be very useful when testing the setup that processes webhooks
        on your end.

        Will use random resource ids for the event.
      operationId: WebhooksController_simulate
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: x-api-secret
          in: header
          required: true
          schema:
            type: string
        - name: webhookId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateWebhookDto'
      responses:
        '201':
          description: ''
components:
  schemas:
    SimulateWebhookDto:
      type: object
      properties:
        event:
          $ref: '#/components/schemas/WebhookEventType'
        screenerResponseUpdatedType:
          $ref: '#/components/schemas/WebhookScreenerResponseUpdatedType'
      required:
        - event
    WebhookEventType:
      type: string
      description: The webhook event type to simulate.
      enum:
        - PROJECTS.UPDATED
        - SCREENER_RESPONSES.CREATED
        - SCREENER_RESPONSES.UPDATED
        - MESSAGES.CREATED
        - CONVERSATIONS.CREATED
    WebhookScreenerResponseUpdatedType:
      type: string
      description: >-
        The status or rejection of the screener to test. Only used for
        `SCREENER_RESPONSES.UPDATED` events.
      enum:
        - STATUS.PAID
        - STATUS.CANCELLED
        - REJECTED.TRUE
        - REJECTED.FALSE

````