@orchesty/connector-twilio
v2.0.0
Published
[](https://www.npmjs.com/package/@orchesty/connector-twilio) [](https://github.com/Orchesty/orchesty-nodejs-conn
Downloads
101
Readme
Twilio Connector
An Orchesty connector for Twilio, a cloud communication platform for building voice, VoIP, and SMS applications via a web API.
Application Type
Basic
This connector authenticates using HTTP Basic auth with your Twilio Account SID and Auth Token (Base64-encoded). The message payload is submitted as multipart/form-data.
| Field | Description |
|---|---|
| user | Your Twilio Account SID |
| password | Your Twilio Auth Token |
Components
| Class | Type | Description |
|---|---|---|
| TwilioSendMessage | Connector | Sends an SMS message via POST /Accounts/{AccountSid}/Messages; submits From, To, and Body as multipart/form-data |
Setup
Credentials
- Log in to the Twilio Console.
- On the dashboard, copy your Account SID and Auth Token.
- In Orchesty, open the Twilio application settings and enter the Account SID as User and the Auth Token as Password.
API Documentation
Twilio SMS API: https://www.twilio.com/docs/sms/api
Installation & Usage
Install the package:
npm install @orchesty/connector-twilio @orchesty/nodejs-sdk
# or
pnpm add @orchesty/connector-twilio @orchesty/nodejs-sdkRegister the application and nodes in your Orchesty DI container:
import { container } from '@orchesty/nodejs-sdk';
import TwilioApplication from '@orchesty/connector-twilio/dist/TwilioApplication';
import TwilioSendMessage from '@orchesty/connector-twilio/dist/Connector/TwilioSendMessage';
const app = new TwilioApplication();
container.setApplication(app);
container.setNode(new TwilioSendMessage(), app);License
This connector is released under the Apache License 2.0. See the LICENSE file for the full license text.
Contributing
Contributions are welcome! This connector is part of the open-source Orchesty Node.js Connectors monorepo.
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the Contributing to Connectors guide.
All contributions should include:
- Source code in
src/following the existing connector structure - Tests in
src/**/__tests__/withinput.json,mock.json, andoutput.jsonfixtures - An updated
CHANGELOG.mdentry
