Dixa Get End User by Email

Looks up a Dixa end user by email address and returns whether the user was found and their user ID.

Overview

This action looks up a Dixa end user (customer) by email address. It returns whether the user was found and, if so, their Dixa user ID.

Use the returned user ID with other Dixa actions, such as Dixa Get EndUser Conversations. For example, check whether a customer has open conversations before an offline handover in chat.

This action requires a Dixa module connection. To set one up, see Dixa.

Inputs

InputTypeDescription
EmailStringThe email address of the Dixa end user to look up

Outputs

OutputTypeDescription
Found?BooleanWhether a Dixa end user with this email address exists
User IDStringThe Dixa end user ID (empty when not found)

Technical Details

  • Endpoint: https://dev.dixa.io/v1/endusers?email={email}
  • Method: GET
  • Runtime: Python 3.13
  • Memory: 256MB

Authentication

The action authenticates with the Dixa module connection selected on the activity. You don't need to pass an API token as an input.

Response Format

The action returns an object containing:

{
  found: boolean,   // true if an end user matches the email address, false otherwise
  user_id: string   // the Dixa end user ID, or null when no user is found
}

Notes:

  • The action trims leading and trailing spaces from the email address before the lookup.
  • If more than one end user matches the email address, the action returns the ID of the first match.
  • A 404 response or an empty result returns found: false instead of an error.
  • An empty email address, or any other unsuccessful response from Dixa, causes the action to fail.

Rate Limiting

If a rate limit is encountered (HTTP 429), the action:

  1. Waits for the time given in the Retry-After header. If the header is missing, it waits 1, 2, then 4 seconds.
  2. Retries the request up to 3 times.
  3. Caps each wait at 5 seconds and the total wait across all retries at 15 seconds.

If the request still returns a 429 after the final retry, the action fails.


Did this page help you?