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 | Select Enabled to activate the rule or Disabled to deactivate 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 name of the endpoint to update the rule of. |
| Mock | Select Enabled to enable mocking for this rule or Disabled to disable mocking for this rule. When enabled, the rule will intercept matching requests and return the configured response. |
| 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. |
| Rule ID | The ID of the required rule. |
| 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
{
"enabled": true,
"mock": true,
"delay": 31000,
"match": {
"method": "POST",
"value": "/customers",
"operator": "SW"
},
"send": {
"status": 200,
"body": "{ }",
"headers": {
"Content-Type": "application/json",
"my-custom-header": "some-data"
},
"templated": false
}
}
Workflow Library Example
Update Rule with Beeceptor and Send Results Via Email