Requirements
Connecting Clearstream takes an active account plus an API access token from your account settings — no other setup is required.[3]https://clearstream.io
Get your Clearstream credentials
- API KeypasswordRequired
In Clearstream, open Settings, then API, and create an API key. A key has full access to your account.
[1] - Account IDtext
Leave blank to use the account that owns the key. To work in a subaccount, enter the subaccount's ID. This only works with a key that can reach subaccounts.
[1]
Connect Clearstream in WEXTL
- Log in to your WEXTL account, add the Clearstream node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Clearstream account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Clearstream node modules
The list below is a reference of every Clearstream node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Clearstream node module below to see exactly what it takes in, what it returns, and what connection it needs.
| Field | Type |
|---|---|
Created At | date |
Event | text |
Production | boolean |
Data | object |
ID | number |
Status | text |
Sent At | date |
Text | text |
To | text |
From | text |
Account | object |
Media | array |
| Field | Type |
|---|---|
Created At | date |
Event | text |
Production | boolean |
Data | object |
ID | number |
Status | text |
Sent At | date |
Text | text |
To | text |
From | text |
Subscriber | object |
Account | object |
Thread | object |
Media | array |
| Field | Type |
|---|---|
Created At | date |
Event | text |
Production | boolean |
Data | object |
Keyword | object |
Thread | object |
Reply | object |
Subscriber | object |
| Field | Type |
|---|---|
Created At | date |
Event | text |
Production | boolean |
Data | object |
Message | object |
| Field | Type |
|---|---|
Mobile Number | text |
Status | text |
Email Status | text |
First Name | text |
Last Name | text |
Full Name | text |
Email | text |
Avatar URL | text |
Source | text |
Source Category | text |
Planning Center Person ID | number |
Church Community Builder Profile ID | number |
Rock RMS Person ID | number |
Lists | array |
List | object |
Tags | array |
Tag | object |
Created At | date |
Updated At | date |
Opted In At | date |
Opted Out At | date |
Deleted At | date |
| Field | Type |
|---|---|
ID | number |
Status | text |
Contact | object |
ID | number |
First Name | text |
Last Name | text |
Mobile Number | text |
Status | text |
Email Status | text |
Email | text |
Avatar URL | text |
Planning Center Person ID | number |
Church Community Builder Profile ID | number |
Number | text |
Text | text |
Created At | date |
| Field | Type |
|---|---|
Timezone | text |
Include Statistics | choice |
| Field | Type |
|---|---|
Business | text |
Status | text |
Phone | text |
Credits | number |
Total Subscribers | number |
Collect Emails | boolean |
Next Billing Date | text |
Plan | object |
Name | text |
Cost | number |
Credits | number |
Keywords | number |
Stats | object |
Opt-Ins | object |
Opt-Outs | object |
Messages | object |
| Field | Type |
|---|---|
Subscribers | number |
Subscribers Opted In to SMS | number |
Subscribers Opted In to Email | number |
Lists | number |
Tags | number |
Keywords | number |
New Subscribers Last Week | number |
| Field | Type |
|---|---|
KeywordRequired | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Header | text |
Shortcode | text |
Created At | date |
Archived At | date |
Autoresponse | object |
Enabled | boolean |
Text | object |
Setting | text |
Opt-In | object |
Enabled | boolean |
Lists | array |
Workflow | object |
Header | text |
Timezone | text |
Steps | array |
Stats | object |
Opt-Ins | object |
Uses | object |
| Field | Type |
|---|---|
MessageRequired | choice |
| Field | Type |
|---|---|
ID | number |
Status | text |
Type | text |
Number | text |
Sent At | date |
Completed At | date |
Text | object |
Full Text | text |
Header | text |
Body | text |
Note | object |
ID | number |
Title | text |
URL | text |
Word Count | number |
Text Preview | text |
User | object |
Created At | date |
Video | object |
ID | number |
Title | text |
URL | text |
Thumbnail URL | text |
Playback URL | text |
Duration | number |
Orientation | text |
Status | text |
Created At | date |
Stats | object |
Lists | array |
Subscribers | array |
Stats | object |
Recipients | number |
Successful | number |
Failures | number |
Throughput | number |
Replies | number |
Opt-Outs | number |
Credits Used | number |
User | object |
ID | number |
Name | text |
Email | text |
Image | text |
Social | object |
Twitter | object |
Facebook | object |
| Field | Type |
|---|---|
SubscriberRequired | choice |
| Field | Type |
|---|---|
Mobile Number | text |
Status | text |
Email Status | text |
First Name | text |
Last Name | text |
Full Name | text |
Email | text |
Avatar URL | text |
Source | object |
ID | number |
Name | text |
Header | text |
Shortcode | text |
Longcode | text |
Type | text |
Autoresponse | object |
Opt-In | object |
Stats | object |
Source Category | text |
Planning Center Person ID | text |
Church Community Builder Profile ID | text |
Rock RMS Person ID | text |
Lists | array |
ID | number |
Name | text |
Joined At | date |
Tags | array |
ID | number |
Name | text |
Created At | date |
Updated At | date |
Opted In At | date |
Opted Out At | date |
Deleted At | date |
| Field | Type |
|---|---|
ThreadRequired | choice |
| Field | Type |
|---|---|
ID | number |
Unread | boolean |
Reply Count | number |
Replied At | date |
Subscriber | object |
Mobile Number | text |
Status | text |
First Name | text |
Last Name | text |
Email | text |
Avatar URL | text |
Related Message | object |
ID | number |
Type | text |
Sent At | date |
Text | object |
Media | object |
Recent Replies | array |
Created At | date |
Updated At | date |
Archived At | date |
| Field | Type |
|---|---|
UserRequired | choice |
| Field | Type |
|---|---|
Email | text |
Name | text |
Image | text |
Email Notifications | object |
Incoming Reply | boolean |
Opt-In | boolean |
Opt-Out | boolean |
Keyword Use | boolean |
Message Fail | boolean |
Weekly Report | boolean |
Push Notifications | object |
Incoming Reply | boolean |
Timezone | text |
Owner | boolean |
Role | text |
| Field | Type |
|---|---|
MessageRequired | choice |
Minutes After Sending | number |
Hours After Sending | number |
Days After Sending | number |
Timezone | text |
Include Charts | choice |
Count Unique Numbers | choice |
| Field | Type |
|---|---|
Meta | object |
Start | date |
End | date |
Timezone | text |
Interval | text |
Totals | object |
Replies | object |
Charts | object |
Reply Chart | array |
| Field | Type |
|---|---|
Headers | array |
Header | text |
| Field | Type |
|---|---|
LimitRequired | number |
Search | text |
Sort By | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Header | text |
Shortcode | text |
Created At | date |
Archived At | date |
Autoresponse | object |
Enabled | boolean |
Text | object |
Setting | text |
Opt-In | object |
Enabled | boolean |
Lists | array |
Workflow | object |
Header | text |
Timezone | text |
Steps | array |
Stats | object |
Opt-Ins | object |
Uses | object |
| Field | Type |
|---|---|
LimitRequired | number |
User ID | number |
Type | choice |
Status | choice |
Search | text |
Sent From Number | text |
Sent After | date |
Sent Before | date |
| Field | Type |
|---|---|
ID | number |
Status | text |
Type | text |
Number | text |
Sent At | date |
Completed At | date |
Text | object |
Full Text | text |
Header | text |
Body | text |
Note | object |
ID | number |
Title | text |
URL | text |
Word Count | number |
Text Preview | text |
User | object |
Created At | date |
Video | object |
ID | number |
Title | text |
URL | text |
Thumbnail URL | text |
Playback URL | text |
Duration | number |
Orientation | text |
Status | text |
Created At | date |
Stats | object |
Lists | array |
Subscribers | array |
Stats | object |
Recipients | number |
Successful | number |
Failures | number |
Throughput | number |
Replies | number |
Opt-Outs | number |
Credits Used | number |
User | object |
ID | number |
Name | text |
Email | text |
Image | text |
Social | object |
Twitter | object |
Facebook | object |
| Field | Type |
|---|---|
ID | number |
Type | text |
Number | text |
Default | boolean |
Can Send Texts | boolean |
Header Required | boolean |
| Field | Type |
|---|---|
LimitRequired | number |
Full Name | text |
First Name | text |
Last Name | text |
Mobile Number | text |
Status | choice |
Created After | date |
Created Before | date |
Updated After | date |
Updated Before | date |
Other Filters | array |
Filter | object |
Combine Filters With | choice |
Sort By | choice |
| Field | Type |
|---|---|
Mobile Number | text |
Status | text |
Email Status | text |
First Name | text |
Last Name | text |
Full Name | text |
Email | text |
Avatar URL | text |
Source | object |
ID | number |
Name | text |
Header | text |
Shortcode | text |
Longcode | text |
Type | text |
Autoresponse | object |
Opt-In | object |
Stats | object |
Source Category | text |
Planning Center Person ID | text |
Church Community Builder Profile ID | text |
Rock RMS Person ID | text |
Lists | array |
ID | number |
Name | text |
Joined At | date |
Tags | array |
ID | number |
Name | text |
Created At | date |
Updated At | date |
Opted In At | date |
Opted Out At | date |
Deleted At | date |
| Field | Type |
|---|---|
ListRequired | choice |
LimitRequired | number |
Full Name | text |
First Name | text |
Last Name | text |
Mobile Number | text |
Status | choice |
Combine Filters With | choice |
Sort By | choice |
| Field | Type |
|---|---|
Mobile Number | text |
Status | text |
First Name | text |
Last Name | text |
Full Name | text |
Email | text |
Source | text |
Source Category | text |
Planning Center Person ID | text |
Church Community Builder Profile ID | text |
Rock RMS Person ID | text |
Created At | date |
Updated At | date |
Joined List At | date |
Opted In At | date |
Opted Out At | date |
| Field | Type |
|---|---|
LimitRequired | number |
Direction | choice |
| Field | Type |
|---|---|
ID | number |
Status | text |
Contact | object |
ID | number |
First Name | text |
Last Name | text |
Mobile Number | text |
Status | text |
Email Status | text |
Email | text |
Avatar URL | text |
Planning Center Person ID | text |
Church Community Builder Profile ID | text |
Number | text |
Text | text |
Created At | date |
| Field | Type |
|---|---|
LimitRequired | number |
Text | text |
Subscriber Name | text |
Subscriber Mobile Number | text |
Archived Status | choice |
Related Message | choice |
| Field | Type |
|---|---|
ID | number |
Unread | boolean |
Reply Count | number |
Replied At | date |
Subscriber | object |
Mobile Number | text |
Status | text |
First Name | text |
Last Name | text |
Email | text |
Avatar URL | text |
Related Message | object |
ID | number |
Type | text |
Sent At | date |
Text | object |
Media | object |
Recent Replies | array |
Created At | date |
Updated At | date |
Archived At | date |
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
Email | text |
Name | text |
Image | text |
Email Notifications | object |
Incoming Reply | boolean |
Opt-In | boolean |
Opt-Out | boolean |
Keyword Use | boolean |
Message Fail | boolean |
Weekly Report | boolean |
Push Notifications | object |
Incoming Reply | boolean |
Timezone | text |
Owner | boolean |
Role | text |
| Field | Type |
|---|---|
ListRequired | choice |
SubscriberRequired | choice |
| Field | Type |
|---|---|
Mobile Number | text |
Status | text |
First Name | text |
Last Name | text |
Full Name | text |
Email | text |
Source | text |
Source Category | text |
Planning Center Person ID | text |
Church Community Builder Profile ID | text |
Rock RMS Person ID | text |
Created At | date |
Updated At | date |
Joined List At | date |
Opted In At | date |
Opted Out At | date |
| Field | Type |
|---|---|
Automated WorkflowRequired | choice |
SubscriberRequired | choice |
Skip Repeat Entries | choice |
| Field | Type |
|---|---|
NameRequired | text |
Number | choice |
Opt In Subscribers | choice |
Opt-In Lists | choice |
Send an Autoresponse | choice |
Autoresponse Header | text |
Autoresponse Body | text |
Autoresponse Setting | choice |
| Field | Type |
|---|---|
ID | number |
Name | text |
Header | text |
Shortcode | text |
Created At | date |
Archived At | date |
Autoresponse | object |
Enabled | boolean |
Text | object |
Setting | text |
Opt-In | object |
Enabled | boolean |
Lists | array |
Workflow | object |
Header | text |
Timezone | text |
Steps | array |
Stats | object |
Opt-Ins | object |
Uses | object |
| Field | Type |
|---|---|
Mobile NumberRequired | text |
Lists | choice |
Tags | choice |
First Name | text |
Last Name | text |
Email | text |
Autoresponse Header | text |
Autoresponse Body | text |
Double Opt-In | choice |
Override Opt-Outs | choice |
Overwrite Existing Details | choice |
| Field | Type |
|---|---|
Mobile Number | text |
Status | text |
Email Status | text |
First Name | text |
Last Name | text |
Full Name | text |
Email | text |
Avatar URL | text |
Source | object |
ID | number |
Name | text |
Header | text |
Shortcode | text |
Longcode | text |
Type | text |
Autoresponse | object |
Opt-In | object |
Stats | object |
Source Category | text |
Planning Center Person ID | text |
Church Community Builder Profile ID | text |
Rock RMS Person ID | text |
Lists | array |
ID | number |
Name | text |
Joined At | date |
Tags | array |
ID | number |
Name | text |
Created At | date |
Updated At | date |
Opted In At | date |
Opted Out At | date |
Deleted At | date |
| Field | Type |
|---|---|
Mobile NumberRequired | text |
HeaderRequired | text |
BodyRequired | text |
Send From Number | choice |
| Field | Type |
|---|---|
ID | number |
Unread | boolean |
Reply Count | number |
Replied At | date |
Subscriber | object |
Mobile Number | text |
Status | text |
First Name | text |
Last Name | text |
Email | text |
Avatar URL | text |
Related Message | object |
ID | number |
Type | text |
Sent At | date |
Text | object |
Media | object |
Recent Replies | array |
Created At | date |
Updated At | date |
Archived At | date |
| Field | Type |
|---|---|
SubscribersRequired | array |
Subscriber | object |
Sync Lists | choice |
Override Opt-Outs | choice |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query string | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Lists | choice |
Subscribers | array |
Mobile Number | text |
Header | text |
Body | text |
Media ID | text |
Media URL | text |
Video ID | text |
Note ID | number |
Poll ID | number |
Send From Number | choice |
Send Time | date |
Time Zone | text |
Save as Draft | choice |
Use Default Header | choice |
Post to Facebook | choice |
Post to Twitter | choice |
| Field | Type |
|---|---|
ID | number |
Status | text |
Type | text |
Number | text |
Sent At | date |
Completed At | date |
Text | object |
Full Text | text |
Header | text |
Body | text |
Note | object |
ID | number |
Title | text |
URL | text |
Word Count | number |
Text Preview | text |
User | object |
Created At | date |
Video | object |
ID | number |
Title | text |
URL | text |
Thumbnail URL | text |
Playback URL | text |
Duration | number |
Orientation | text |
Status | text |
Created At | date |
Stats | object |
Lists | array |
Subscribers | array |
Stats | object |
Recipients | number |
Successful | number |
Failures | number |
Throughput | number |
Replies | number |
Opt-Outs | number |
Credits Used | number |
User | object |
ID | number |
Name | text |
Email | text |
Image | text |
Social | object |
Twitter | object |
Facebook | object |
| Field | Type |
|---|---|
ToRequired | array |
Phone Number | text |
Text BodyRequired | text |
Text Header | text |
From Number | choice |
Media URL | text |
Use Default Header | choice |
Override Opt-Outs | choice |
| Field | Type |
|---|---|
ID | number |
Status | text |
Queued At | date |
Text | text |
To | array |
Phone Number | text |
Skipped | array |
Phone Number | text |
From | text |
Media | array |
Media | object |
| Field | Type |
|---|---|
Business | text |
Phone | text |
Collect Emails | choice |
| Field | Type |
|---|---|
Business | text |
Status | text |
Phone | text |
Credits | number |
Total Subscribers | number |
Collect Emails | boolean |
Next Billing Date | text |
Plan | object |
Name | text |
Cost | number |
Credits | number |
Keywords | number |
Stats | object |
Opt-Ins | object |
Opt-Outs | object |
Messages | object |
| Field | Type |
|---|---|
SubscriberRequired | choice |
First Name | text |
Last Name | text |
Email | text |
Lists | choice |
Tags | choice |
Status | choice |
| Field | Type |
|---|---|
Mobile Number | text |
Status | text |
Email Status | text |
First Name | text |
Last Name | text |
Full Name | text |
Email | text |
Avatar URL | text |
Source | object |
ID | number |
Name | text |
Header | text |
Shortcode | text |
Longcode | text |
Type | text |
Autoresponse | object |
Opt-In | object |
Stats | object |
Source Category | text |
Planning Center Person ID | text |
Church Community Builder Profile ID | text |
Rock RMS Person ID | text |
Lists | array |
ID | number |
Name | text |
Joined At | date |
Tags | array |
ID | number |
Name | text |
Created At | date |
Updated At | date |
Opted In At | date |
Opted Out At | date |
Deleted At | date |
Templates
Look for Clearstream templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Bandwidth[2]Enterprise communications APIs for voice, messaging, and phone number services.
- ButtondownIndie newsletter platform for writing, sending, and managing email lists.
- AcumbamailEmail marketing platform for campaigns, lists, and subscriber automation.
- Autocalls AIAI phone agents for outbound and inbound calling, lead qualification, and follow-ups.
- CallTrackingMetricsCall tracking for businesses, with numbers, texts, and routing.
References
- WEXTL® Clearstream Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Clearstream.
- WEXTL® visual workflow builder data.
Last updated: Oct 12, 2026 10:56