Skip to content

Commit b86c620

Browse files
committed
add documentation to the options parameter
1 parent ae4d545 commit b86c620

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/sdk/eventtrigger.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,26 @@ You can have multiple Jobs that subscribe to the same event, they will all trigg
4545
```
4646

4747
</ResponseField>
48+
<ResponseField name="examples" type="array">
49+
Used to provide example payloads that are accepted by the job.
50+
51+
This will be available in the dashboard and can be used to trigger test runs.
52+
53+
<Expandable title="example object properties" defaultOpen>
54+
<ResponseField name="id" type="string" required>
55+
The example's ID.
56+
</ResponseField>
57+
<ResponseField name="name" type="string" required>
58+
The name that's displayed in the dashboard.
59+
</ResponseField>
60+
<ResponseField name="payload" type="object" required>
61+
The payload that's accepted by the job.
62+
</ResponseField>
63+
<ResponseField name="icon" type="string">
64+
The icon to use for this example in the dashboard.
65+
</ResponseField>
66+
</Expandable>
67+
</ResponseField>
4868

4969
</Expandable>
5070
</ResponseField>

0 commit comments

Comments
 (0)