PlatformDocs
MCP server

test_webhook

Sends a sample lead, as automations send them, to a URL so you can check your endpoint receives and parses it.

View as Markdown

Test a webhook · Changes data · Acts outside your account

Sends a sample lead, as automations send them, to a URL so you can check your endpoint receives and parses it. Returns the status your endpoint answered.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringYesanyWebsite ID from list_websites.
webhookstringYesuriThe public http(s) URL to send the sample lead to (private or local addresses are refused).
signalTypestringNodefault "visit" · visit, topic, web_scrapingWhich sample to send, shaped like the automation that will use it: visit (a website visitor, default), topic (3rd-party intent) or web_scraping (a web-scraping signal).

Tool definition

What your assistant receives from tools/list:

{
  "name": "test_webhook",
  "title": "Test a webhook",
  "annotations": {
    "title": "Test a webhook",
    "readOnlyHint": false,
    "destructiveHint": false,
    "idempotentHint": false,
    "openWorldHint": true
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website ID from list_websites."
      },
      "webhook": {
        "type": "string",
        "format": "uri",
        "description": "The public http(s) URL to send the sample lead to (private or local addresses are refused)."
      },
      "signalType": {
        "type": "string",
        "enum": [
          "visit",
          "topic",
          "web_scraping"
        ],
        "default": "visit",
        "description": "Which sample to send, shaped like the automation that will use it: visit (a website visitor, default), topic (3rd-party intent) or web_scraping (a web-scraping signal)."
      }
    },
    "required": [
      "websiteId",
      "webhook"
    ]
  }
}

On this page