List Bookings with Booking Experts API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Booking Experts, Twilio SendGrid and 3,000+ other apps remarkably fast.

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

List Bookings with the Booking Experts 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 Twilio SendGrid trigger and Booking Experts action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
Configure the List Bookings action
1. Connect your Booking Experts account
2. Select a Administration ID
3. Optional- Select a Owner ID
4. Optional- Select a Administration Channel ID
5. Select one or more Reservation IDs
6. Optional- Configure Created At
7. Optional- Configure Updated At
8. Optional- Configure Page
9. Optional- Configure Per Page
10. Optional- Select a Booking ID
11. Optional- Select one or more Customer IDs
12. Optional- Select a Booking Number
13. Optional- Configure Confirmed At
14. Optional- Configure Fields Booking
15. Optional- Configure Reference Number
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.7

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to 3,000+ other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
N/A	`http`	`$.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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

List Bookings on Booking Experts

Description:Returns a list of bookings for an administration. [See the documentation](https://developers.bookingexperts.com/reference/administration-bookings-index)

Version:0.0.7

Key:booking_experts-list-bookings

View on GitHub

Action Code#

import bookingExperts from "../../booking_experts.app.mjs";

export default {
  key: "booking_experts-list-bookings",
  name: "List Bookings",
  description: "Returns a list of bookings for an administration. [See the documentation](https://developers.bookingexperts.com/reference/administration-bookings-index)",
  version: "0.0.7",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    bookingExperts,
    administrationId: {
      propDefinition: [
        bookingExperts,
        "administrationId",
      ],
    },
    ownerId: {
      propDefinition: [
        bookingExperts,
        "ownerId",
        (c) => ({
          administrationId: c.administrationId,
        }),
      ],
      description: "Filter by owner",
    },
    administrationChannelId: {
      propDefinition: [
        bookingExperts,
        "administrationChannelId",
        (c) => ({
          administrationId: c.administrationId,
        }),
      ],
      description: "Filter by channel",
    },
    reservationIds: {
      type: "string[]",
      label: "Reservation IDs",
      description: "Filter by reservation IDs",
      propDefinition: [
        bookingExperts,
        "reservationId",
        (c) => ({
          administrationId: c.administrationId,
        }),
      ],
    },
    createdAt: {
      type: "string",
      label: "Created At",
      description: "Filter by created at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)",
      optional: true,
    },
    updatedAt: {
      type: "string",
      label: "Updated At",
      description: "Filter by updated at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)",
      optional: true,
    },
    page: {
      propDefinition: [
        bookingExperts,
        "page",
      ],
    },
    perPage: {
      propDefinition: [
        bookingExperts,
        "perPage",
      ],
    },
    filterId: {
      optional: true,
      propDefinition: [
        bookingExperts,
        "bookingId",
        ({ administrationId }) => ({
          administrationId,
        }),
      ],
    },
    customerIds: {
      type: "string[]",
      label: "Customer IDs",
      description: "Filter by customer IDs",
      propDefinition: [
        bookingExperts,
        "customerId",
        ({ administrationId }) => ({
          administrationId,
        }),
      ],
    },
    bookingNr: {
      label: "Booking Number",
      description: "Filter by booking number",
      optional: true,
      propDefinition: [
        bookingExperts,
        "bookingId",
        ({ administrationId }) => ({
          administrationId,
          mapper: ({ attributes: { booking_nr: value } }) => value,
        }),
      ],
    },
    confirmedAt: {
      type: "string",
      label: "Confirmed At",
      description: "Filter by confirmed at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)",
      optional: true,
    },
    fieldsBooking: {
      type: "string[]",
      label: "Fields Booking",
      description: "Fields to return for the booking",
      optional: true,
    },
    referenceNr: {
      type: "string",
      label: "Reference Number",
      description: "Filter by reference number",
      optional: true,
    },
  },
  methods: {
    commaSeparatedList(value) {
      return Array.isArray(value) && value?.length > 0
        ? value.join(",")
        : value;
    },
  },
  async run({ $ }) {
    const {
      commaSeparatedList,
      administrationId,
      ownerId,
      administrationChannelId,
      reservationIds,
      createdAt,
      updatedAt,
      page,
      perPage,
      filterId,
      customerIds,
      bookingNr,
      confirmedAt,
      fieldsBooking,
      referenceNr,
    } = this;

    const { data } = await this.bookingExperts.listBookings({
      $,
      administrationId,
      params: {
        "filter[owner]": ownerId,
        "filter[channel]": administrationChannelId,
        "filter[created_at]": createdAt,
        "filter[updated_at]": updatedAt,
        "page[number]": page,
        "page[size]": perPage,
        "filter[ID]": filterId,
        "filter[reservations]": commaSeparatedList(reservationIds),
        "filter[customer]": commaSeparatedList(customerIds),
        "filter[booking_nr]": bookingNr,
        "filter[confirmed_at]": confirmedAt,
        "fields[booking]": commaSeparatedList(fieldsBooking),
        "filter[reference_nr]": referenceNr,
      },
    });
    $.export("$summary", `Found ${data.length} bookings`);
    return data;
  },
};

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
Booking Experts	`bookingExperts`	`app`	This component uses the Booking Experts app.
Administration ID	`administrationId`	`string`	Select a value from the drop down menu.
Owner ID	`ownerId`	`string`	Select a value from the drop down menu.
Administration Channel ID	`administrationChannelId`	`string`	Select a value from the drop down menu.
Reservation IDs	`reservationIds`	`string[]`	Select a value from the drop down menu.
Created At	`createdAt`	`string`	Filter by created at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)
Updated At	`updatedAt`	`string`	Filter by updated at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)
Page	`page`	`integer`	Page number
Per Page	`perPage`	`integer`	Number of items per page
Booking ID	`filterId`	`string`	Select a value from the drop down menu.
Customer IDs	`customerIds`	`string[]`	Select a value from the drop down menu.
Booking Number	`bookingNr`	`string`	Select a value from the drop down menu.
Confirmed At	`confirmedAt`	`string`	Filter by confirmed at (ISO 8601 format, e.g., `2024-01-01T00:00:00Z`)
Fields Booking	`fieldsBooking`	`string[]`	Fields to return for the booking
Reference Number	`referenceNr`	`string`	Filter by reference number

List Bookings with Booking Experts API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Booking Experts, Twilio SendGrid and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular