Skip to content

chore: update Actions Triggers docs #1908

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
nlucero merged 1 commit into from
Sep 21, 2026
Merged

chore: update Actions Triggers docs #1908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion main/docs/actions/reference/_metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"schemaVersion": "0.32.0"
"schemaVersion": "0.33.0"
}
4 changes: 2 additions & 2 deletions ...cs/actions/reference/credentials-exchange/credentials-exchange-event-object.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ The `event` object for the credentials-exchange Actions trigger provides context

```json Event Object
{
"secrets": {},
"accessToken": {
"customClaims": {},
"scope": []
Expand All @@ -39,7 +38,8 @@ The `event` object for the credentials-exchange Actions trigger provides context
},
"transaction": {
"requested_scopes": []
}
},
"secrets": {}
}
```

Expand Down
4 changes: 2 additions & 2 deletions .../actions/reference/custom-email-provider/custom-email-provider-event-object.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ The `event` object for the custom-email-provider Actions trigger provides contex

```json Event Object
{
"secrets": {},
"client": {
"client_id": "string",
"metadata": {},
Expand All @@ -34,7 +33,8 @@ The `event` object for the custom-email-provider Actions trigger provides contex
"tenant": {
"id": "string"
},
"user": {}
"user": {},
"secrets": {}
}
```

Expand Down
12 changes: 6 additions & 6 deletions .../actions/reference/custom-phone-provider/custom-phone-provider-event-object.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ The `event` object for the custom-phone-provider Actions trigger provides contex

```json Event Object
{
"secrets": {},
"client": {
"client_id": "string",
"metadata": {},
Expand All @@ -36,7 +35,8 @@ The `event` object for the custom-phone-provider Actions trigger provides contex
"tenant": {
"id": "string"
},
"user": {}
"user": {},
"secrets": {}
}
```

Expand Down Expand Up @@ -297,6 +297,10 @@ The `event` object for the custom-phone-provider Actions trigger provides contex
User's given name.
</ResponseField>

<ResponseField name="identities" type="array of objects" post={["optional"]}>
Contains info retrieved from the identity provider with which the user originally authenticates. Users may also link their profile to multiple identity providers; those identities will then also appear in this array. The contents of an individual identity provider object varies by provider.
</ResponseField>

<ResponseField name="last_password_reset" type="string" post={["optional"]}>
Timestamp indicating the last time the user's password was reset/changed. At user creation, this field does not exist. This property is only available for Database connections.
</ResponseField>
Expand Down Expand Up @@ -336,9 +340,5 @@ The `event` object for the custom-phone-provider Actions trigger provides contex
<ResponseField name="username" type="string" post={["optional"]}>
(unique) User's username.
</ResponseField>

<ResponseField name="identities" type="array of objects" post={["optional"]}>
Contains info retrieved from the identity provider with which the user originally authenticates. Users may also link their profile to multiple identity providers; those identities will then also appear in this array. The contents of an individual identity provider object varies by provider.
</ResponseField>
</Expandable>
</ResponseField>
19 changes: 18 additions & 1 deletion main/docs/actions/reference/event-stream/event-stream-event-object.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ The `event` object for the event-stream Actions trigger provides contextual info
"id": "string",
"type": "string",
"source": "string",
"specversion": "string"
"specversion": "string",
"a0tenant": "string"
}
}
```
Expand Down Expand Up @@ -55,6 +56,22 @@ The `event` object for the event-stream Actions trigger provides contextual info
<ResponseField name="time" type="string" post={["optional"]}>
Timestamp of when the occurrence happened. Must adhere to RFC 3339.
</ResponseField>

<ResponseField name="a0tenant" type="string">
The Auth0 tenant identifier to which the event is associated.
</ResponseField>

<ResponseField name="a0stream" type="string" post={["optional"]}>
The Auth0 event stream ID of the stream the event was delivered on.
Present when the event is delivered via an event stream; omitted when
events are retrieved via the Events API (GET /api/v2/events).
</ResponseField>

<ResponseField name="a0purpose" type="string" post={["optional"]}>
The purpose of this event. Set only in special cases such as a test event; omitted for normal events.

Allowed values: `test`
</ResponseField>
</Expandable>
</ResponseField>

Expand Down
Loading