Skip to content

chore: add example for eventTrigger() doc #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericallam merged 2 commits into from
Oct 6, 2023
Merged

chore: add example for eventTrigger() doc #541

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae4d545
chore: add example for eventTrigger() doc
hmacr Oct 3, 2023
b86c620
add documentation to the options parameter
hmacr Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/sdk/eventtrigger.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,26 @@ You can have multiple Jobs that subscribe to the same event, they will all trigg
```

</ResponseField>
<ResponseField name="examples" type="array">
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.

<Expandable title="example object properties" defaultOpen>
<ResponseField name="id" type="string" required>
The example's ID.
</ResponseField>
<ResponseField name="name" type="string" required>
The name that's displayed in the dashboard.
</ResponseField>
<ResponseField name="payload" type="object" required>
The payload that's accepted by the job.
</ResponseField>
<ResponseField name="icon" type="string">
The icon to use for this example in the dashboard.
</ResponseField>
</Expandable>
</ResponseField>

</Expandable>
</ResponseField>
Expand All @@ -70,6 +90,19 @@ client.defineJob({
filter: {
tier: ["pro"],
},
//(optional) example event object
examples: [
{
id: "issue.opened",
name: "Issue opened",
payload: {
userId: "1234",
tier: "free",
},
//optional
icon: "github",
},
],
}),
run: async (payload, io, ctx) => {
await io.logger.log("New pro user created", { userId: payload.userId });
Expand Down