Test custom webhook
test_custom_webhookSends a sample article payload to the connected webhook with its saved settings and secret or, with url, to an endpoint that is not connected yet (without the secret, like the dashboard test before saving). Reports whether the endpoint answered 2xx within 30 seconds and the error otherwise. The sample uses random ids and fills every optional field; it never reproduces the multi-language fan-out. Limited to 30 tests per hour. Free. Pass website_id when the account has several websites (see get_account).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Endpoint to test before connecting it. Omit to test the connected webhook with its saved settings and secret. | |
| format | No | Format of the sample payload, only with url. | markdown |
| website_id | No | Website id from get_account. Optional when the account has a single website. | |
| auth_method | No | generated (recommended): BlogSEO creates a shared secret and sends it in the X-Webhook-Secret header. custom: BlogSEO sends the header you name with the value you give. | generated |
| custom_header_name | No | Header name, only with auth_method=custom. | |
| custom_header_value | No | Header value, only with auth_method=custom. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Endpoint tested; null when the connected webhook was tested. | |
| detail | Yes | ||
| passed | Yes | ||
| status_code | Yes |