Parameters

id
string
required

The id of the registration. The identifier you use will be available in the context.source.id when the Job runs. It will also be used to unregister.

params
Object
required

The shape of this object will depend on the type of event you set when constructing the DynamicTrigger.

options
object
accountId
string

An optional account ID to use when running the job. This will be available in the Job context and can be used in auth resolvers

filter
EventFilter

An optional filter to apply to the event. See our EventFilter guide for more

Returns

id
string

The id of the schedule that was registered.