eventTrigger()
eventTrigger()
is set as a Job’s trigger to subscribe to an event a Job from a sent event.
There are two way to send an event that will trigger eventTrigger()
:
- Use client.sendEvent() from anywhere in your codebase.
- Use io.sendEvent() from inside a Job's
run()
function.
You can have multiple Jobs that subscribe to the same event, they will all trigger when the event gets delivered.
Parameters
The name of the event you are subscribing to. Must be an exact match (case sensitive).
A Zod schema that defines the shape of the
event payload. The default is z.any()
which is any
.
You can use this to filter events based on the source.
Used to filter which events trigger the Job.
An example:
{
name: ["John", "Jane"],
age: [18, 21]
}
This filter would match against an event with the following data:
{
"name": "Jane",
"age": 18,
"location": "San Francisco"
}
Used to provide example payloads that are accepted by the job.
This will be available in the dashboard and can be used to trigger test runs.
The example’s ID.
The name that’s displayed in the dashboard.
The payload that’s accepted by the job.
The icon to use for this example in the dashboard.
Was this page helpful?