Skip to content

Conversation

@khaliqgant
Copy link
Member

@khaliqgant khaliqgant commented Dec 2, 2025


Expose endUserEmail in auth webhook payloads

This PR expands auth webhook payloads to include the optional endUserEmail, wiring the value through sendAuth and updating the shared NangoAuthWebhookBodyBase type definition. Documentation across webhook, API auth, and quickstart guides now calls out the email field so integrators know to persist it alongside endUserId.

Key Changes

• Populate endUserEmail in the endUser object built by sendAuth in packages/webhooks/lib/auth.ts
• Extend NangoAuthWebhookBodyBase in packages/types/lib/webhooks/api.ts to type the optional endUserEmail field
• Refresh webhook/API auth/quickstart documentation to show the new endUserEmail property and tidy markdown spacing

Affected Areas

packages/webhooks/lib/auth.ts
packages/types/lib/webhooks/api.ts
docs/implementation-guides/platform/webhooks-from-nango.mdx
docs/implementation-guides/api-auth/implement-api-auth.mdx
docs/getting-started/quickstart/embed-in-your-app.mdx


This summary was automatically generated by @propel-code-bot

# 6. Re-authorize an existing connection

There are cases where you need to re-authorize a connection, e.g. credentials have expired or the scopes/permissions have changed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Documentation]

Fix grammar: 'all it's associated data' should be 'all its associated data'.

Context for Agents
[**Documentation**]

Fix grammar: 'all it's associated data' should be 'all its associated data'.

File: docs/implementation-guides/api-auth/implement-api-auth.mdx
Line: 219

}
}
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Documentation]

Fix grammar: 'referred as' should be 'referred to as'.

Context for Agents
[**Documentation**]

Fix grammar: 'referred as' should be 'referred to as'.

File: docs/implementation-guides/platform/webhooks-from-nango.mdx
Line: 233


In some cases, a connection belongs to an organization rather than a user. In such cases, fill in the relevant organization information and use a place holder for the required `end_user.id` (or use the information of the user who initiated the authorization flow).
</Info>
In some cases, a connection belongs to an organization rather than a user. In such cases, fill in the relevant organization information and use a place holder for the required `end_user.id` (or use the information of the user who initiated the authorization flow).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Documentation]

Fix spelling: 'place holder' should be 'placeholder'.

Context for Agents
[**Documentation**]

Fix spelling: 'place holder' should be 'placeholder'.

File: docs/getting-started/quickstart/embed-in-your-app.mdx
Line: 88

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants