Rules in depth

Every control and text this screen shows, in screen order. The list is read from the demo by a crawl, and CI fails when the screen changes without its entry here.

Webhooks > Rules decides which events go to which endpoint: each rule picks events and, optionally, a filter on their fields.

The screen as a whole: Rules.

The numbers match the entries below. The picture shows the first screenful; controls further down, and texts, have no marker.

On the screenCopy Anchor Link

1. RulesCopy Anchor Link

Heading.

• What it does: Names the open screen in the header.

2. Read the Rules guideCopy Anchor Link

Link.

• What it does: Opens this screen's page in the user guide, in a new tab.
• Links to: Rules.

3. Webhook rulesCopy Anchor Link

Heading.

• What it does: The rules that decide which events go to which endpoint.
• Same action elsewhere: REST GET /api/v1/webhooks/rules, CLI sendmock webhook rule list, MCP sendmock_webhook_rule_list

4. Which events go to which endpoint, checked from top to bottom.Copy Anchor Link

Text.

• What it does: Explains the screen: every matching rule delivers, in this order.

5. Add ruleCopy Anchor Link

Button.

• What it does: Opens the new rule editor; in it, adds the rule.
• Same action elsewhere: REST POST /api/v1/webhooks/rules, CLI sendmock webhook rule create, MCP sendmock_webhook_rule_create

6. Endpoint filterCopy Anchor Link

Drop-down.

• What it does: Shows the rules of every endpoint, or of one.

7. OrderCopy Anchor Link

Column.

• What it does: The rule's place, with buttons to move it.

8. RuleCopy Anchor Link

Column.

• What it does: The rule's name and endpoint.

9. EventsCopy Anchor Link

Column.

• What it does: The events it sends.

10. FilterCopy Anchor Link

Column.

• What it does: Its filter, in words.

11. OnCopy Anchor Link

Column.

• What it does: Whether it is on.

12. ActionsCopy Anchor Link

Column.

• What it does: Edit and Delete.

13. Move … upCopy Anchor Link

Button, in each row.

• What it does: Moves the rule one place up.
• Same action elsewhere: REST POST /api/v1/webhooks/rules/{ruleId}/move, CLI sendmock webhook rule move, MCP sendmock_webhook_rule_move

14. Move … downCopy Anchor Link

Button, in each row.

• What it does: Moves the rule one place down.
• Same action elsewhere: REST POST /api/v1/webhooks/rules/{ruleId}/move, CLI sendmock webhook rule move, MCP sendmock_webhook_rule_move

15. … enabledCopy Anchor Link

Switch, in each row.

• What it does: Turns the rule on or off at once.
• Same action elsewhere: REST PATCH /api/v1/webhooks/rules/{ruleId}, CLI sendmock webhook rule update, MCP sendmock_webhook_rule_update

16. Edit …Copy Anchor Link

Button, in each row.

• What it does: Opens the rule's editor.
• Same action elsewhere: REST GET /api/v1/webhooks/rules/{ruleId}, CLI sendmock webhook rule show, MCP sendmock_webhook_rule_get

17. Delete …Copy Anchor Link

Button, in each row.

• What it does: Asks for confirmation, then deletes the rule.

New rule editorCopy Anchor Link

18. Add a ruleCopy Anchor Link

Heading.

• What it does: The new rule editor.

19. Which events go to the endpoint, and only when the filter matches.Copy Anchor Link

Text.

• What it does: Explains the editor.

20. NameCopy Anchor Link

Field.

• What it does: The rule's name.

21. EndpointCopy Anchor Link

Drop-down.

• What it does: The endpoint matching events are delivered to.
• Links to: Endpoints.

22. EventsCopy Anchor Link

Heading.

• What it does: The events the rule sends; tick one or more.

23. email.receivedCopy Anchor Link

Checkbox.

• What it does: Sends email.received, fired when an email your app sent arrives (SMTP, a provider API, sendmail or the native API).

24. email.inboundCopy Anchor Link

Checkbox.

• What it does: Sends email.inbound, fired when an incoming email arrives: a simulated reply or forward, or mail to an inbound domain.

25. email.openedCopy Anchor Link

Checkbox.

• What it does: Sends email.opened, fired when an email is opened.

26. email.clickedCopy Anchor Link

Checkbox.

• What it does: Sends email.clicked, fired when a link of an email is clicked.

27. email.deliveredCopy Anchor Link

Checkbox.

• What it does: Sends email.delivered, fired when an email is marked delivered.

28. email.deferredCopy Anchor Link

Checkbox.

• What it does: Sends email.deferred, fired when an email's delivery is deferred.

29. email.bouncedCopy Anchor Link

Checkbox.

• What it does: Sends email.bounced, fired when an email bounces.

30. email.complainedCopy Anchor Link

Checkbox.

• What it does: Sends email.complained, fired when a spam complaint is recorded.

31. email.unsubscribedCopy Anchor Link

Checkbox.

• What it does: Sends email.unsubscribed, fired when an unsubscribe is recorded.

32. email.releasedCopy Anchor Link

Checkbox.

• What it does: Sends email.released, fired when an email is released to a real inbox.

33. email.deletedCopy Anchor Link

Checkbox.

• What it does: Sends email.deleted, fired when an email is deleted.

34. sms.sentCopy Anchor Link

Checkbox.

• What it does: Sends sms.sent, fired when your app sends an SMS.

35. sms.statusCopy Anchor Link

Checkbox.

• What it does: Sends sms.status, fired when an SMS changes status.

36. sms.openedCopy Anchor Link

Checkbox.

• What it does: Sends sms.opened, fired when an SMS is read.

37. sms.inboundCopy Anchor Link

Checkbox.

• What it does: Sends sms.inbound, fired when an inbound SMS arrives.

38. verify.startedCopy Anchor Link

Checkbox.

• What it does: Sends verify.started, fired when a verification starts.

39. verify.checkedCopy Anchor Link

Checkbox.

• What it does: Sends verify.checked, fired when a code is checked, or a verification is approved, canceled or runs out of attempts.

40. verify.expiredCopy Anchor Link

Checkbox.

• What it does: Sends verify.expired, fired when a verification expires.

41. push.sentCopy Anchor Link

Checkbox.

• What it does: Sends push.sent, fired when your app sends a push notification through FCM, Expo or OneSignal.

42. push.failedCopy Anchor Link

Checkbox.

• What it does: Sends push.failed, fired when a push notification is refused, as a magic device token asks.

43. http.capturedCopy Anchor Link

Checkbox.

• What it does: Sends http.captured, fired when the HTTP catcher captures a request.

44. payment.createdCopy Anchor Link

Checkbox.

• What it does: Sends payment.created, fired when a payment is created.

45. payment.authorizedCopy Anchor Link

Checkbox.

• What it does: Sends payment.authorized, fired when a payment is authorized.

46. payment.succeededCopy Anchor Link

Checkbox.

• What it does: Sends payment.succeeded, fired when a payment succeeds.

47. payment.failedCopy Anchor Link

Checkbox.

• What it does: Sends payment.failed, fired when a payment fails.

48. payment.canceledCopy Anchor Link

Checkbox.

• What it does: Sends payment.canceled, fired when a payment is canceled or voided.

49. payment.refundedCopy Anchor Link

Checkbox.

• What it does: Sends payment.refunded, fired when a payment is refunded in full.

50. payment.partially_refundedCopy Anchor Link

Checkbox.

• What it does: Sends payment.partially_refunded, fired when part of a payment is refunded.

51. payment.dispute_openedCopy Anchor Link

Checkbox.

• What it does: Sends payment.dispute_opened, fired when a dispute is opened.

52. payment.dispute_updatedCopy Anchor Link

Checkbox.

• What it does: Sends payment.dispute_updated, fired when a dispute is answered or changes.

53. payment.dispute_closedCopy Anchor Link

Checkbox.

• What it does: Sends payment.dispute_closed, fired when a dispute is closed.

54. checkout.completedCopy Anchor Link

Checkbox.

• What it does: Sends checkout.completed, fired when a checkout is completed.

55. checkout.expiredCopy Anchor Link

Checkbox.

• What it does: Sends checkout.expired, fired when a checkout expires.

56. subscription.createdCopy Anchor Link

Checkbox.

• What it does: Sends subscription.created, fired when a subscription is created.

57. subscription.renewedCopy Anchor Link

Checkbox.

• What it does: Sends subscription.renewed, fired when a subscription renews.

58. subscription.payment_failedCopy Anchor Link

Checkbox.

• What it does: Sends subscription.payment_failed, fired when a subscription's renewal payment fails.

59. subscription.canceledCopy Anchor Link

Checkbox.

• What it does: Sends subscription.canceled, fired when a subscription is canceled.

60. webhook.failedCopy Anchor Link

Checkbox.

• What it does: Sends webhook.failed, fired when a webhook delivery fails for good.

61. test.pingCopy Anchor Link

Checkbox.

• What it does: Sends test.ping, fired when an endpoint test is sent.

62. FilterCopy Anchor Link

Heading.

• What it does: Conditions on the event's fields; with none, every selected event is sent.
• Links to: Advanced: rules and filters.

63. Negate filterCopy Anchor Link

Button.

• What it does: Sends the events that do not match the filter instead.

64. Filter combinatorCopy Anchor Link

Drop-down.

• What it does: Whether all conditions must match, or any one.

65. No conditions: every selected event fires.Copy Anchor Link

Text.

• What it does: Shown while the filter is empty.

66. Add conditionCopy Anchor Link

Button.

• What it does: Adds a condition.

67. Add groupCopy Anchor Link

Button.

• What it does: Adds a group of conditions with its own all or any.

68. PreviewCopy Anchor Link

Heading.

• What it does: Tries the rule on recent real messages before you save it.
• Same action elsewhere: REST POST /api/v1/webhooks/rules/preview, CLI sendmock webhook rule preview, MCP sendmock_webhook_rule_preview

69. Matches # of the last # messagesCopy Anchor Link

Text.

• What it does: How many recent messages the rule would send.

70. Show non-matchingCopy Anchor Link

Switch.

• What it does: Lists the recent messages that would not be sent too, with the condition that failed.

71. MatchesCopy Anchor Link

Badge.

• What it does: Marks a recent message the rule matches.

72. CancelCopy Anchor Link

Button.

• What it does: Closes the editor without saving.

73. Add ruleCopy Anchor Link

Button.

• What it does: Adds the rule; it applies to the next event.
• Same action elsewhere: REST POST /api/v1/webhooks/rules, CLI sendmock webhook rule create, MCP sendmock_webhook_rule_create

74. CloseCopy Anchor Link

Button.

• What it does: Closes the editor without saving.

Rule editorCopy Anchor Link

75. Support inbox to LaravelCopy Anchor Link

Heading.

• What it does: The rule open in the editor (here a demo rule).

76. Which events go to the endpoint, and only when the filter matches.Copy Anchor Link

Text.

• What it does: Explains the editor.

77. NameCopy Anchor Link

Field.

• What it does: The rule's name.

78. EndpointCopy Anchor Link

Drop-down.

• What it does: The endpoint matching events are delivered to.
• Links to: Endpoints.

79. EventsCopy Anchor Link

Heading.

• What it does: The events the rule sends; tick one or more.

80. email.receivedCopy Anchor Link

Checkbox.

• What it does: Sends email.received, fired when an email your app sent arrives (SMTP, a provider API, sendmail or the native API).

81. email.inboundCopy Anchor Link

Checkbox.

• What it does: Sends email.inbound, fired when an incoming email arrives: a simulated reply or forward, or mail to an inbound domain.

82. email.openedCopy Anchor Link

Checkbox.

• What it does: Sends email.opened, fired when an email is opened.

83. email.clickedCopy Anchor Link

Checkbox.

• What it does: Sends email.clicked, fired when a link of an email is clicked.

84. email.deliveredCopy Anchor Link

Checkbox.

• What it does: Sends email.delivered, fired when an email is marked delivered.

85. email.deferredCopy Anchor Link

Checkbox.

• What it does: Sends email.deferred, fired when an email's delivery is deferred.

86. email.bouncedCopy Anchor Link

Checkbox.

• What it does: Sends email.bounced, fired when an email bounces.

87. email.complainedCopy Anchor Link

Checkbox.

• What it does: Sends email.complained, fired when a spam complaint is recorded.

88. email.unsubscribedCopy Anchor Link

Checkbox.

• What it does: Sends email.unsubscribed, fired when an unsubscribe is recorded.

89. email.releasedCopy Anchor Link

Checkbox.

• What it does: Sends email.released, fired when an email is released to a real inbox.

90. email.deletedCopy Anchor Link

Checkbox.

• What it does: Sends email.deleted, fired when an email is deleted.

91. sms.sentCopy Anchor Link

Checkbox.

• What it does: Sends sms.sent, fired when your app sends an SMS.

92. sms.statusCopy Anchor Link

Checkbox.

• What it does: Sends sms.status, fired when an SMS changes status.

93. sms.openedCopy Anchor Link

Checkbox.

• What it does: Sends sms.opened, fired when an SMS is read.

94. sms.inboundCopy Anchor Link

Checkbox.

• What it does: Sends sms.inbound, fired when an inbound SMS arrives.

95. verify.startedCopy Anchor Link

Checkbox.

• What it does: Sends verify.started, fired when a verification starts.

96. verify.checkedCopy Anchor Link

Checkbox.

• What it does: Sends verify.checked, fired when a code is checked, or a verification is approved, canceled or runs out of attempts.

97. verify.expiredCopy Anchor Link

Checkbox.

• What it does: Sends verify.expired, fired when a verification expires.

98. push.sentCopy Anchor Link

Checkbox.

• What it does: Sends push.sent, fired when your app sends a push notification through FCM, Expo or OneSignal.

99. push.failedCopy Anchor Link

Checkbox.

• What it does: Sends push.failed, fired when a push notification is refused, as a magic device token asks.

100. http.capturedCopy Anchor Link

Checkbox.

• What it does: Sends http.captured, fired when the HTTP catcher captures a request.

101. payment.createdCopy Anchor Link

Checkbox.

• What it does: Sends payment.created, fired when a payment is created.

102. payment.authorizedCopy Anchor Link

Checkbox.

• What it does: Sends payment.authorized, fired when a payment is authorized.

103. payment.succeededCopy Anchor Link

Checkbox.

• What it does: Sends payment.succeeded, fired when a payment succeeds.

104. payment.failedCopy Anchor Link

Checkbox.

• What it does: Sends payment.failed, fired when a payment fails.

105. payment.canceledCopy Anchor Link

Checkbox.

• What it does: Sends payment.canceled, fired when a payment is canceled or voided.

106. payment.refundedCopy Anchor Link

Checkbox.

• What it does: Sends payment.refunded, fired when a payment is refunded in full.

107. payment.partially_refundedCopy Anchor Link

Checkbox.

• What it does: Sends payment.partially_refunded, fired when part of a payment is refunded.

108. payment.dispute_openedCopy Anchor Link

Checkbox.

• What it does: Sends payment.dispute_opened, fired when a dispute is opened.

109. payment.dispute_updatedCopy Anchor Link

Checkbox.

• What it does: Sends payment.dispute_updated, fired when a dispute is answered or changes.

110. payment.dispute_closedCopy Anchor Link

Checkbox.

• What it does: Sends payment.dispute_closed, fired when a dispute is closed.

111. checkout.completedCopy Anchor Link

Checkbox.

• What it does: Sends checkout.completed, fired when a checkout is completed.

112. checkout.expiredCopy Anchor Link

Checkbox.

• What it does: Sends checkout.expired, fired when a checkout expires.

113. subscription.createdCopy Anchor Link

Checkbox.

• What it does: Sends subscription.created, fired when a subscription is created.

114. subscription.renewedCopy Anchor Link

Checkbox.

• What it does: Sends subscription.renewed, fired when a subscription renews.

115. subscription.payment_failedCopy Anchor Link

Checkbox.

• What it does: Sends subscription.payment_failed, fired when a subscription's renewal payment fails.

116. subscription.canceledCopy Anchor Link

Checkbox.

• What it does: Sends subscription.canceled, fired when a subscription is canceled.

117. webhook.failedCopy Anchor Link

Checkbox.

• What it does: Sends webhook.failed, fired when a webhook delivery fails for good.

118. test.pingCopy Anchor Link

Checkbox.

• What it does: Sends test.ping, fired when an endpoint test is sent.

119. FilterCopy Anchor Link

Heading.

• What it does: Conditions on the event's fields; with none, every selected event is sent.
• Links to: Advanced: rules and filters.

120. Negate filterCopy Anchor Link

Button.

• What it does: Sends the events that do not match the filter instead.

121. Filter combinatorCopy Anchor Link

Drop-down.

• What it does: Whether all conditions must match, or any one.

122. Negate conditionCopy Anchor Link

Button.

• What it does: Turns that one condition around.

123. FieldCopy Anchor Link

Drop-down.

• What it does: The event field the condition reads, such as data.to[0].address or data.subject.

124. Remove conditionCopy Anchor Link

Button.

• What it does: Removes the condition.

125. OperatorCopy Anchor Link

Drop-down.

• What it does: How the field is compared: equals, contains, matches a pattern, is in a list, and so on.

126. ValueCopy Anchor Link

Field.

• What it does: What the field is compared with.

127. Add conditionCopy Anchor Link

Button.

• What it does: Adds a condition.

128. Add groupCopy Anchor Link

Button.

• What it does: Adds a group of conditions with its own all or any.

129. PreviewCopy Anchor Link

Heading.

• What it does: Tries the rule on recent real messages before you save it.
• Same action elsewhere: REST POST /api/v1/webhooks/rules/preview, CLI sendmock webhook rule preview, MCP sendmock_webhook_rule_preview

130. Matches # of the last # messagesCopy Anchor Link

Text.

• What it does: How many recent messages the rule would send.

131. Show non-matchingCopy Anchor Link

Switch.

• What it does: Lists the recent messages that would not be sent too, with the condition that failed.

132. No recent message matches.Copy Anchor Link

Text.

• What it does: Shown when none of the recent messages would be sent.

133. CancelCopy Anchor Link

Button.

• What it does: Closes the editor without saving.

134. Save changesCopy Anchor Link

Button.

• What it does: Saves the rule; it applies to the next event.
• Same action elsewhere: REST PATCH /api/v1/webhooks/rules/{ruleId}, CLI sendmock webhook rule update, MCP sendmock_webhook_rule_update

135. CloseCopy Anchor Link

Button.

• What it does: Closes the editor without saving.

Delete rule dialogCopy Anchor Link

136. Delete Support inbox to Laravel?Copy Anchor Link

Heading.

• What it does: The confirmation before deleting a rule (here a demo rule).

137. Its events stop going to the endpoint. Past deliveries stay in the log.Copy Anchor Link

Text.

• What it does: Says what deleting changes.

138. Keep itCopy Anchor Link

Button.

• What it does: Closes the confirmation without deleting.

139. DeleteCopy Anchor Link

Button.

• What it does: Deletes the rule.
• Same action elsewhere: REST DELETE /api/v1/webhooks/rules/{ruleId}, CLI sendmock webhook rule delete, MCP sendmock_webhook_rule_delete

When the data cannot loadCopy Anchor Link

140. Could not load the rules. Try againCopy Anchor Link

Message.

• What it does: Shown when the rules could not be loaded.
• Errors: Check SendMock is running, then press Try again.

141. Could not load the rules.Copy Anchor Link

Text.

• What it does: The message inside the alert.

142. Try againCopy Anchor Link

Button.

• What it does: Loads the rules again.
• Same action elsewhere: REST GET /api/v1/webhooks/rules, CLI sendmock webhook rule list, MCP sendmock_webhook_rule_list