Skip to content

Commit

Permalink
Added note about timing object and subtle behavior differences.
Browse files Browse the repository at this point in the history
Ref: #801.
  • Loading branch information
jhuckaby committed Aug 30, 2024
1 parent 25ce7e7 commit 6cf86b7
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/APIReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,8 @@ In addition to the required parameters, almost anything in the [Event Data Objec
}
```

In the above example we've included a `timing` object, and set it to run daily at 9:20 PM and 9:40 PM in the `America/New_York` timezone. If you omit the `timing` object entirely, the event becomes "on demand", and can only be run manually via user or API. If you do include a `timing` object but keep it empty (no properties inside it), the event will run **every** minute of **every** day of **every** month of **every** year.

Example response:

```js
Expand Down

0 comments on commit 6cf86b7

Please sign in to comment.