Skip to content

feat: document external_id in webhook #2277

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: document external_id in webhook #2277

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
16 changes: 16 additions & 0 deletions docs/guides/integrate-with-ory-cloud-through-webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,22 @@ verification or recovery addresses, these will be deleted unless the identity tr
}
```

#### Update the identity's external ID

When the webhook target returns a 200 OK response code and the response body is a JSON object with the key `identity.external_id`
in it, the value from that object will be used to replace the identity's external ID before it is saved to the database. This
method replaces the previous external ID, if any.

```json
{
"identity": {
// highlight-start
"external_id": "external-id-from-webhook"
// highlight-end
}
}
```

### Flow-interrupting webhooks

If you want the result of webhook execution to have the potential of interrupting the flow, you can configure the webhook to parse
Expand Down
Loading