Integrations
Segment integration
A Segment Function you paste into your workspace checks the address of identify calls and of the track events you name, and adds the status to the event. With a write key it also sends each result back into Segment as traits, for your profiles and your warehouse.
- Status: Setup guide
- An insert or destination function
apiKey ev_live_… (String, secret, required)
region eu for EU data residency
checkIdentify true
trackEvents Signed Up, Email Changed
writeKey an HTTP API source’s write key (secret)At a glance.
- Status
- Setup guide. Not listed on a marketplace yet: you set it up yourself in a few steps, below and in the full guide.
- For
- Teams that run sign-ups and profile changes through Segment and want their email tool, CRM and warehouse to receive each address’s status.
- You need
- A Segment workspace with Functions, and an API key made for it, with a daily credit cap used only by this function.
- Costs
- 1 credit = 1 validated address, as with any API request. Free: unknown results, API errors, malformed addresses and test addresses on sandbox.email-validation.org.
- Full guide
- Read the full setup guide
Typical uses.
Enrich a destination
As an insert function attached to a cloud-mode destination, it adds ev_status, ev_reason, ev_action and ev_processed_at to each event, for example to suppress invalid addresses in your email tool.
Status on your profiles
With the write-back, each result arrives at an HTTP API source of yours as an identify call with the four fields as traits, and from there reaches your profiles and your warehouse.
Check only new addresses
Name the track events that carry a new or changed address in trackEvents, and set checkIdentify to false if your app sends identify calls on every visit.
Set it up. 6 steps.
The short version of the full setup guide, which stays the reference when a step does not match what you see.
Create a key
Create an API key for Segment on the API keys page, with a daily credit cap.
Create the function
In Segment, go to Connections, Catalog, open the Functions tab and click New Function. Choose Insert, or Destination.
Paste the code
Replace the editor’s code with the function in the guide.
Add the settings
In the Settings tab, add at least apiKey, marked as secret, and any of the optional settings you need.
Test it
In the Test tab, send an identify call with
accepted@sandbox.email-validation.orgastraits.email. The output shows the event with the four fields added.Deploy and connect
Save and deploy it, then connect an insert function to the destination it should enrich, or a destination function to the source whose events it should check.
Good to know.
- Every event it checks is one validation. Functions keep no lasting state, so an identify call that repeats an address already checked is charged again; the cache it uses while it runs saves some repeat checks, but Segment can empty it at any time.
- Segment runs insert functions only in front of cloud-mode destinations, not warehouses. A destination function cannot change events, so always give it a writeKey: without one its checks are charged and the results are seen only in its logs.
- It never stops or drops your events. When a check cannot be done, the event goes on without the four fields, and the log says why with the HTTP status, our error code and the request id, never the address.
- Segment stops a function after 5 seconds, so it waits a little less for each check. A check that got no answer is not sent again, because it may already have been charged; in a destination function, retryLater makes Segment try an event again after a rate limit or an outage.
- A catalog destination is built but not submitted to Segment yet, so it cannot be added from the catalog today. The guide says what it will do.
Updated · Maintained by the email-validation.org team