---
updatedAt: 2026-07-24T08:27:13.000Z
agentTools:
  projectIndex: https://docs.fire.com/llms.txt
---

# Send test webhooks

This endpoint sends a test webhook response for a selected event to the chosen URL. You will need to enable PERM_BUSINESS_GET_WEBHOOK_EVENT_TEST to use this endpoint.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Fire Financial Services Business API",
    "description": "The fire.com API allows you to deeply integrate Business Account features into your application or back-office systems.\n",
    "version": "1.0",
    "contact": {
      "name": "Fire API",
      "url": "https://docs.fire.com",
      "email": "api@fire.com"
    }
  },
  "servers": [
    {
      "url": "https://api.fire.com/business",
      "description": "Production Server"
    }
  ],
  "paths": {
    "/v2/webhooks/{webhookId}/events/{event}/test": {
      "get": {
        "summary": "Send test webhooks",
        "description": "This endpoint sends a test webhook response for a selected event to the chosen URL. You will need to enable PERM_BUSINESS_GET_WEBHOOK_EVENT_TEST to use this endpoint.",
        "tags": [
          "API and Webhooks"
        ],
        "operationId": "sendTestWebhook",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "webhookId",
            "schema": {
              "type": "integer",
              "format": "int64",
              "description": "The ID of the webhook to test",
              "example": 32
            }
          },
          {
            "in": "path",
            "required": true,
            "name": "event",
            "schema": {
              "type": "string",
              "enum": [
                "LODGEMENT_RECEIVED",
                "PAYMENT_RECEIVED",
                "PAYMENT_REQUEST_PAYMENT_RECEIVED",
                "ACCOUNT_CREATED",
                "CARD_CREATED",
                "CARD_AUTHORISATION",
                "CARD_SETTLEMENT",
                "PAYMENT_REQUEST_PAYMENT_AUTHORISED",
                "PIS_LODGEMENT_RECEIVED"
              ],
              "description": "The type of event to send. Currently only one event type is associated with each webhook, however this may change in future.",
              "example": "CARD_AUTHORISATION"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Webhook test sent."
          },
          "400": {
            "description": "An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.",
            "content": {
              "application/json": {
                "schema": {
                  "title": "apiErrors",
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ApiErrorV2"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.",
            "content": {
              "application/json": {
                "schema": {
                  "title": "apiErrors",
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ApiErrorV2"
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.",
            "content": {
              "application/json": {
                "schema": {
                  "title": "apiErrors",
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ApiErrorV2"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "webhooks": {
    "webhook": {
      "post": {
        "summary": "Event Webhook",
        "tags": [
          "Webhooks"
        ],
        "description": "Webhooks allow you to be notified of events as they happen on your Fire accounts. The below sample response shows how a webhook from Fire will arrive at your server. See our 'Webhooks' guide for more detailed information.",
        "requestBody": {
          "required": true,
          "content": {
            "application/jwt": {
              "schema": {
                "type": "string",
                "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A 200 response is required from your server. Returns a 200 response to indicate that the data was received successfully."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API Access Token"
      }
    },
    "schemas": {
      "ApiErrorV2": {
        "title": "apiError",
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int64",
            "description": "Error Code",
            "example": 50051
          },
          "message": {
            "type": "string",
            "description": "The error message",
            "example": "Sorry, we are unable to proceed with your request."
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "API and Webhooks",
      "description": "Manage your API Applications and Webhooks"
    },
    {
      "name": "Webhooks",
      "description": "Events you can receive in realtime"
    }
  ]
}
```