POST /accounts/{account_id}/alerting/v3/policies/{policy_id}/test
Send a test notification for a policy to verify delivery mechanisms are working as expected.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
policy_id |
String | Yes | |
account_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
source |
String | No |
Source identifier for the test alert. |
state_event |
Integer | No |
State event type for stateful test alerts. Use with state_correlation_id. Valid values:
|
state_correlation_id |
String | No |
Correlation ID for stateful test alerts. Required when state_event is set. |
severity |
Integer | No |
Severity level for the test alert. Defaults to INFO (1) if omitted. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.