Skip to content

Commit 684254e

Browse files
committed
API Doc: Added note in run_event about overriding event properties, and specifying tags.
1 parent 028604c commit 684254e

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

docs/api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1210,9 +1210,11 @@ Parameters (core):
12101210
| `params` | Object | Optional overrides for [Event.params](data.md#event-params). Missing keys fall back to the event's saved params. |
12111211
| `input` | Object | Optional input object; may include `data` and/or `files` (see [Job.input](data.md#job-input)). Uploaded files are appended to `input.files`. |
12121212
| `test` | Boolean | If `true`, bypasses manual-trigger and enabled checks and marks the job as a test. |
1213+
| `tags` | Array | Optionally override tags set in the event. Specify one or more [Tag.id](data.md#tag-id)s in the array. |
12131214

12141215
Additional behaviors:
12151216

1217+
- Any properties from the event are overridable here. See the [Event](data.md#event) data structure for details.
12161218
- Nested keys using `parent/child` can be supplied as flat parameters (e.g. `params/foo=bar`).
12171219
- When using multipart uploads, the `json` field should contain the exact JSON you would otherwise POST.
12181220
- If the `post_data` query parameter is present, all raw POST fields are placed under `post_data` instead of being merged (advanced usage).

0 commit comments

Comments
 (0)