Send New SMS with Octopush SMS API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Octopush SMS, HTTP / Webhook and 2,900+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Send New SMS with the Octopush SMS API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HTTP / Webhook trigger and Octopush SMS action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Send New SMS action
1. Connect your Octopush SMS account
2. Configure Text
3. Configure Phone Number
4. Configure First Name
5. Configure Last Name
6. Select a Type
7. Optional- Configure Sender
8. Optional- Configure Send At
9. Optional- Select a Purpose
10. Optional- Configure With Replies
11. Optional- Configure Simulation Mode
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Send New SMS on Octopush SMS

Description:Sends a new SMS using Octopush SMS. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/send-sms/)

Version:0.0.2

Key:octopush_sms-send-new-sms

View on GitHub

Octopush SMS Overview#

The Octopush SMS API lets you programmatically send text messages, providing a powerful way to reach out to customers directly on their phones. With Pipedream, you can create workflows that trigger SMS sending via Octopush based on various events, streamlining communication processes. You could use this API to send alerts, reminders, verification codes, or marketing messages, and integrate with other apps to respond to emails, form submissions, or updates in a CRM.

Action Code#

import octopush from "../../octopush_sms.app.mjs";

export default {
  key: "octopush_sms-send-new-sms",
  name: "Send New SMS",
  description: "Sends a new SMS using Octopush SMS. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/send-sms/)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    octopush,
    text: {
      type: "string",
      label: "Text",
      description: "The message text (from 1 to 1224 characters).",
    },
    phone: {
      type: "string",
      label: "Phone Number",
      description: "Phone number of the recipient",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the recipient",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the recipient",
    },
    type: {
      type: "string",
      label: "Type",
      description: "Campaign Type",
      options: [
        "sms_premium",
        "sms_low_cost",
      ],
    },
    sender: {
      type: "string",
      label: "Sender",
      description: "Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9)",
      optional: true,
    },
    sendAt: {
      type: "string",
      label: "Send At",
      description: "When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”)",
      optional: true,
    },
    purpose: {
      type: "string",
      label: "Purpose",
      description: "Campaign purpose",
      options: [
        "alert",
        "wholesale",
      ],
      optional: true,
    },
    withReplies: {
      type: "boolean",
      label: "With Replies",
      description: "Set to `true` to get back recipient replies",
      optional: true,
    },
    simulationMode: {
      type: "boolean",
      label: "Simulation Mode",
      description: "If this value is `true`, your request will be simulated, and you will receive a fake result",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.octopush.sendSMS({
      $,
      data: {
        text: this.text,
        recipients: [
          {
            phone_number: this.phone,
            first_name: this.firstName,
            last_name: this.lastName,
          },
        ],
        type: this.type,
        send_at: this.sendAt,
        purpose: this.purpose,
        with_replies: this.withReplies,
        simulation_mode: this.simulationMode,
      },
    });
    $.export("$summary", "Successfully send new SMS.");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Octopush SMS	`octopush`	`app`	This component uses the Octopush SMS app.
Text	`text`	`string`	The message text (from 1 to 1224 characters).
Phone Number	`phone`	`string`	Phone number of the recipient
First Name	`firstName`	`string`	First name of the recipient
Last Name	`lastName`	`string`	Last name of the recipient
Type	`type`	`string`	Select a value from the drop down menu:`sms_premiumsms_low_cost`
Sender	`sender`	`string`	Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9)
Send At	`sendAt`	`string`	When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”)
Purpose	`purpose`	`string`	Select a value from the drop down menu:`alertwholesale`
With Replies	`withReplies`	`boolean`	Set to `true` to get back recipient replies
Simulation Mode	`simulationMode`	`boolean`	If this value is `true`, your request will be simulated, and you will receive a fake result

Action Authentication#

Octopush SMS uses API keys for authentication. When you connect your Octopush SMS account, Pipedream securely stores the keys so you can easily authenticate to Octopush SMS APIs in both code and no-code steps.

You can get your API Login and Key under API & Integrations > HTTP API Credentials.

About Octopush SMS#

SMS Marketing software.

More Ways to Connect Octopush SMS + HTTP / Webhook#

Other Popular Integrations#

Add Contact with Octopush SMS API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Octopush SMS

Try it

Add Contact with Octopush SMS API on New Requests from HTTP / Webhook API

HTTP / Webhook + Octopush SMS

Try it

Send New SMS with Octopush SMS API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Octopush SMS

Try it

Add Contact with Octopush SMS API on New event when the content of the URL changes. from HTTP / Webhook API

HTTP / Webhook + Octopush SMS

Try it

Send New SMS with Octopush SMS API on New event when the content of the URL changes. from HTTP / Webhook API

HTTP / Webhook + Octopush SMS

Try it

Popular Triggers#

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it