Skip to content

Commit 7bfe2f7

Browse files
authored
feat: document external_id in webhook (#2277)
1 parent e12ed02 commit 7bfe2f7

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/guides/integrate-with-ory-cloud-through-webhooks.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -523,6 +523,22 @@ verification or recovery addresses, these will be deleted unless the identity tr
523523
}
524524
```
525525

526+
#### Update the identity's external ID
527+
528+
When the webhook target returns a 200 OK response code and the response body is a JSON object with the key `identity.external_id`
529+
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
530+
method replaces the previous external ID, if any.
531+
532+
```json
533+
{
534+
"identity": {
535+
// highlight-start
536+
"external_id": "external-id-from-webhook"
537+
// highlight-end
538+
}
539+
}
540+
```
541+
526542
### Flow-interrupting webhooks
527543

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

0 commit comments

Comments
 (0)