Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Heymarket SMS

Heymarket is a business texting platform that gives you the power to engage with people using shared inboxes.

CategoryCommerce
Authenticationcustom
Version0.1.0
Published scopes0 published scopes
Last updatedSeptember 19, 2026

Overview

Connect Heymarket SMS with Flows360

Heymarket is a business texting platform that gives you the power to engage with people using shared inboxes.

Use the Heymarket SMS connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 5 actions and 2 triggers.

Available actions

  • Create or Update Contact
  • Send Custom Message
  • Send Template Message
  • Update List
  • Custom API Call

Available triggers

  • Conversation Started
  • New or Updated Contact

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Heymarket SMS
  • Package: @activepieces/piece-heymarket-sms@0.1.0
  • Exact artifact digest: sha256:a479a7d44cb602d7f1c60749bab3aaefafd61ee3400bad574aca3dc6c0ab5a54
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

SECRET TEXT. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Create or Update Contact (createOrUpdateContact), Create a new contact or update an existing contact by phone number Classification: read.
  • Send Custom Message (sendCustomMessage), Send a custom text message to an individual contact or a list Classification: read.
  • Send Template Message (sendTemplateMessage), Send a message using a template to an individual contact or a list Classification: read.
  • Update List (updateList), Update an existing list in your team by adding or removing members, or updating list properties Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • Conversation Started, polling.
  • New or Updated Contact, polling.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

Authenticationcustom
Supported objects7
Supported actions5
Triggers2

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • Heymarket API Key Required · protected credential

Supported objects

ObjectReadWriteNotes
Create or Update Contact Yes No Create a new contact or update an existing contact by phone number
Send Custom Message Yes No Send a custom text message to an individual contact or a list
Send Template Message Yes No Send a message using a template to an individual contact or a list
Update List Yes No Update an existing list in your team by adding or removing members, or updating list properties
Custom API Call Yes No Make a custom API call to a specific endpoint
Conversation Started Yes No polling trigger declared by the pinned package.
New or Updated Contact Yes No polling trigger declared by the pinned package.

Supported actions

Create or Update Contact · Read

Create a new contact or update an existing contact by phone number

create_or_update_contact · Risk: low · Retry: safe

Inputs

  • phone · string · Required, Phone number in E.164 format without the plus sign (e.g. 14155553434)
  • first · string · Optional, First name of the contact
  • last · string · Optional, Last name of the contact
  • display_name · string · Optional, Display name of the contact
  • email · string · Optional, Email address of the contact
  • tags · array · Optional, Array of tags
  • is_opted_out · boolean · Optional, Whether the contact is opted out of messaging
  • contact_id · string · Optional, Contact ID for updating an existing contact. If not provided, will attempt to create a new contact
  • overwrite · boolean · Optional, When true, replaces all existing custom fields. When false, merges with existing ones. Note: contact name is always overwritten
Send Custom Message · Read

Send a custom text message to an individual contact or a list

send_custom_message · Risk: low · Retry: safe

Inputs

  • inbox_id · number · Required, Unique identifier for the inbox from which the message will be sent
  • creator_id · number · Required, Unique identifier for the sender (member ID from Get Inboxes)
  • text · string · Required, Custom message text body
  • phone_number · string · Optional, Phone number in E.164 format without the plus sign (e.g. 14155553434). Required if not sending to a list or chat
  • targets · array · Optional, Array of phone numbers in E.164 format without the plus sign for group MMS messages
Send Template Message · Read

Send a message using a template to an individual contact or a list

send_template_message · Risk: low · Retry: safe

Inputs

  • inbox_id · number · Required, Unique identifier for the inbox from which the message will be sent
  • creator_id · number · Required, Unique identifier for the sender (member ID from Get Inboxes)
  • template_id · number · Required, Unique identifier for the Heymarket template to send
  • phone_number · string · Optional, Phone number in E.164 format without the plus sign (e.g. 14155553434). Required if not sending to a list
  • targets · array · Optional, Array of phone numbers in E.164 format without the plus sign for group MMS messages
  • text · string · Optional, Optional message text body to override or supplement the template
Update List · Read

Update an existing list in your team by adding or removing members, or updating list properties

update_list · Risk: low · Retry: safe

Inputs

  • list_id · number · Required, Unique identifier for the list to update
  • title · string · Required, Updated name for the list
  • add_phone · string · Optional, Phone number in E.164 format without the plus sign to add to the list (e.g. 14155553434)
  • remove_phone · string · Optional, Phone number in E.164 format without the plus sign to remove from the list (e.g. 14155553434)
  • members · object · Optional, Object of list targets. Keys are phone numbers, values are objects with optional first name (f) and last name (l)
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Triggers

Conversation Started · Poll

Trigger when a new conversation is started or an existing conversation is updated

Inputs

  • userId · number
  • inboxId · string
New or Updated Contact · Poll

Trigger when a new contact is created or an existing contact is updated

Setup

Setup

  1. Add the Heymarket SMS connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • No provider credential fields are declared by the pinned package.
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-heymarket-sms@0.1.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 5 actions and 2 triggers declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Heymarket SMS connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-heymarket-sms@0.1.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com