Function: postMembersWebhookRefreshEmail()

postMembersWebhookRefreshEmail<ThrowOnError>(options?): RequestResult<PostMembersWebhookRefreshEmailResponses, PostMembersWebhookRefreshEmailErrors, ThrowOnError>

Defined in: api/sdk.gen.ts:807

Handles incoming webhooks from authentication system to synchronize email changes. The UpdateEmailWebhook endpoint is a specialized administrative entry point that listens for external signals regarding identity updates. It validates the request using a shared secret and enqueues a background task to refresh the member's email address in the local database, ensuring the application stays in sync with the central identity provider.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostMembersWebhookRefreshEmailData, ThrowOnError, unknown>

Returns

RequestResult<PostMembersWebhookRefreshEmailResponses, PostMembersWebhookRefreshEmailErrors, ThrowOnError>