Integrating your scheduled events

{
  "images": [
    {
      "image": [
        "https://files.readme.io/6667698373d677a60f311dc3bb4e3aa9a7d6a8706a6229814d93e197c2443c59-Screenshot_2024-09-04_at_15.28.01.png",
        "",
        "Synced Events display in the platform"
      ],
      "align": "center",
      "caption": "Synced Events display in the platform"
    }
  ]
}
{
  "images": [
    {
      "image": [
        "https://files.readme.io/2ebf33e-Screenshot_2024-07-28_at_10.59.17.png",
        "",
        ""
      ],
      "align": "left",
      "sizing": "45px"
    }
  ]
}
{
  "data": {
    "h-0": "Parameter Name",
    "h-1": "Data Type",
    "h-2": "Description",
    "h-3": "Sample Value",
    "h-4": "Required",
    "h-5": "Validations",
    "0-0": "externalId",
    "0-1": "string",
    "0-2": "The external ID of the event.  \nThis id is used to identify the event and decide if this is a create or an update operation.",
    "0-3": "\"67890\"",
    "0-4": "Yes",
    "0-5": "",
    "1-0": "name",
    "1-1": "string",
    "1-2": "The name of the event",
    "1-3": "\"Test\"",
    "1-4": "Yes",
    "1-5": "",
    "2-0": "startTime",
    "2-1": "string",
    "2-2": "Start date and time of the event in ISO 8601 format",
    "2-3": "\"2024-07-18T10:00:00Z\"",
    "2-4": "Yes",
    "2-5": "",
    "3-0": "endTime",
    "3-1": "string",
    "3-2": "End date and time of the event in ISO 8601 format",
    "3-3": "\"2024-07-18T12:00:00Z\"",
    "3-4": "Yes",
    "3-5": "Must be after startTime",
    "4-0": "location",
    "4-1": "object",
    "4-2": "The location of the event. The endpoint supports finding event by id or name. If not found, geometry details can be provided and a location will be created and linked to the event.",
    "4-3": "{\"id\":\"6593f162212b18a3b182f23b\"  }",
    "4-4": "Yes",
    "4-5": "Each location must have location id or name and GeoJSON geometry (point, polygon, polyline) in case the location does not exist.",
    "5-0": "groups",
    "5-1": "array of strings",
    "5-2": "The group names that will be subscribed to the event.",
    "5-3": "",
    "5-4": "No",
    "5-5": "The groups must exist in the platform before linking them to the event.  \n  \nMax 50 groups in the array.",
    "6-0": "users",
    "6-1": "array of strings",
    "6-2": "The user emails that will be subscribed to the event.",
    "6-3": "",
    "6-4": "No",
    "6-5": "Max 50 users in the array.",
    "7-0": "eventTags",
    "7-1": "array of strings",
    "7-2": "Tags associated with the event. The tags will be set to the event and are shown in the platform UI.",
    "7-3": "",
    "7-4": "No",
    "7-5": "Max 50 tags in the array.",
    "8-0": "alertTags",
    "8-1": "array of strings",
    "8-2": "Alert tags associated with the event. The alerts tags is one way to link alerts to the event. Any alert with the specified tag will be linked to the event.",
    "8-3": "",
    "8-4": "No",
    "8-5": "Max 50 tags in the array.",
    "9-0": "alertIds",
    "9-1": "array of strings",
    "9-2": "The alert ids for which the event will be linked to.",
    "9-3": "",
    "9-4": "No",
    "9-5": "The alerts must exist in the platform before linking them to the event.  \n  \nMax 50 alerts in the array.",
    "10-0": "persistLocation",
    "10-1": "boolean",
    "10-2": "Configuration of whether to persist the location.  \n  \nBy default, location that doesn't exists and received in the request will be created and deleted once the event is over. Setting this parameter to ‘True’ will result in not deleting the location when the event is over.  \n  \nIf the use case is for temporary locations it is advised to set this to false so the locations quotas won't be exceeded.",
    "10-3": "false",
    "10-4": "No",
    "10-5": ""
  },
  "cols": 6,
  "rows": 11,
  "align": [
    null,
    null,
    null,
    null,
    null,
    null
  ]
}
{
  "images": [
    {
      "image": [
        "https://files.readme.io/1c79aebcb7a08bfe20b61cebd13a4b66aecdd66d8901793a8fc02b50dec8849c-Screenshot_2024-09-04_at_16.20.49.png",
        "",
        ""
      ],
      "align": "left",
      "sizing": "55px"
    }
  ]
}