External DocumentationTo learn more, visit the Beeceptor documentation.
Parameters
| Parameter | Description |
|---|---|
| Delay | The response delay in milliseconds before returning the mocked response. |
| Description | An optional description to help identify and organize the rule. |
| Enabled | Check to enable the rule, Uncheck to disable it. Disabled rules are not applied to incoming requests. |
| Endpoint Match - HTTP Method | The HTTP method that incoming requests must match. |
| Endpoint Match - Operator | Select how the rule matches incoming requests against the specified value. |
| Endpoint Match - Value | The value to match against incoming requests, based on the selected operator (path, regex pattern, body content, or header value). |
| Endpoint Name | The endpoint name where the rule will be created. |
| Mock | Check to set the rule as mock. When unchecked, mocking is not attempted and only the delay is effective. |
| Random Responses | A list of response objects with percentage weights as JSON array. Each response must comply with the required response object properties. For more details please see Beeceptor’s API documentation. |
| Response Body | The response body content to return (JSON or text). For example: |
| Response Headers | The response headers to send as a JSON object. For example: |
| Response Status | The HTTP status code to return when this rule matches. |
| Send Type | The response type for the rule. Choose send for a fixed response or sendRandom for randomly selected responses. |
| Templated Response | Select true to enable HandleBar templating in the mocked response for dynamic content.For more information about the Templated Response parameter please visit Beeceptor documentation. |
Example Output
{
"data": {
"enabled": true,
"mock": true,
"delay": 0,
"match": {
"method": "GET",
"operator": "SW",
"value": "/my-api-path"
},
"send": {
"status": 200,
"body": "{ \"status\": \"Awesome!\"}",
"headers": {
"Content-Type": "application/json",
"my-custom-header": "some-data"
},
"templated": false
},
"id": "s6ocngast47"
}
}
Workflow Library Example
Create Rule with Beeceptor and Send Results Via Email