The Event Rules model has the following endpoints:
Action | Method | resource | Description |
---|---|---|---|
Get All Event Rules |
|
| |
Find Event Rules |
|
| |
Update Event Rule |
|
| |
Create Event Rule |
|
| |
Remove Event Rule |
|
| |
Get All Event Channels |
|
| |
Find Event Channel |
|
| |
Create Event Channel |
|
| |
Update Event Channel |
|
| |
Delete Event Channel |
|
|
Event Rules info
- Only admins can use this endpoints
The Event rule model is composed of the following attributes:
Attribute | Type | Required | Description | Whereable |
---|---|---|---|---|
name** | String | Yes | Name of event rule | Yes |
description** | String | No | Event rule description | Yes |
enabled | Boolean | No | Identifier to know if event rule is activated | Yes |
launch_type | Select | Yes | The identifier to know if the rule event is a 'times' or 'date' | Yes |
date | Date | Yes | Required if 'launch_type' is set to 'date' | Yes |
times | Array | Yes | Required if 'launch_type' is set to 'times' | Yes |
type | Select | Yes | For now only one selection: 'abandoned_cart' | Yes |
The Event Rule Channels model is composed of the following attributes:
Attribute | Type | Required | Description |
---|---|---|---|
title** | String | Yes | Name of the event channel |
body** | String | Yes | |
enabled** | Boolean | No | Identifier to know if event rule is activated |
channel** | String | Yes | Identifier of which channel type. 'email', 'sms', 'notification' |