Get Events with TicketSauce API

Pipedream makes it easy to connect APIs for TicketSauce and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Events with the TicketSauce 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#

Create a workflow to Get Events with the TicketSauce API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Events action
1. Connect your TicketSauce account
2. Optional- Configure Partner ID
3. Optional- Configure Organization ID
4. Optional- Configure Start After
5. Optional- Configure End Before
6. Optional- Configure Active Only
7. Optional- Select a Privacy Type
8. Optional- Select a Sort By
9. Optional- Select a Sort Direction
10. Optional- Configure Include Performers
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Get Events on TicketSauce

Description:Get a list of all events owned by the authenticated account. [See documentation](https://speca.io/ticketsauce/ticketsauce-public-api?key=204000d6bda66da78315e721920f43aa#list-of-events)

Version:0.0.1

Key:ticketsauce-get-events

View on GitHub

Code#

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

export default {
  key: "ticketsauce-get-events",
  name: "Get Events",
  description: "Get a list of all events owned by the authenticated account. [See documentation](https://speca.io/ticketsauce/ticketsauce-public-api?key=204000d6bda66da78315e721920f43aa#list-of-events)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    ticketsauce,
    partnerId: {
      propDefinition: [
        ticketsauce,
        "partnerId",
      ],
    },
    organizationId: {
      propDefinition: [
        ticketsauce,
        "organizationId",
      ],
    },
    startAfter: {
      type: "string",
      label: "Start After",
      description: "Only retrieve events that start AFTER the specified UTC date (format: `YYYY-MM-DD`).",
      optional: true,
    },
    endBefore: {
      type: "string",
      label: "End Before",
      description: "Only retrieve events that end BEFORE the specified UTC date (format: `YYYY-MM-DD`).",
      optional: true,
    },
    activeOnly: {
      type: "boolean",
      label: "Active Only",
      description: "Leaving this as true will restrict retrieved events to only 'active' events. Setting to false will allow the retrieval of both active and inactive events.",
      optional: true,
      default: true,
    },
    privacyType: {
      type: "string",
      label: "Privacy Type",
      description: "Filter events by privacy type.",
      optional: true,
      default: "public",
      options: [
        {
          label: "Public events only",
          value: "public",
        },
        {
          label: "All events (no restriction)",
          value: "all",
        },
        {
          label: "Unlisted events only",
          value: "unlisted",
        },
      ],
    },
    sortBy: {
      type: "string",
      label: "Sort By",
      description: "Field to sort events by.",
      optional: true,
      options: [
        {
          label: "Event start date",
          value: "date",
        },
        {
          label: "Event name",
          value: "name",
        },
        {
          label: "City location",
          value: "city",
        },
      ],
    },
    sortDir: {
      type: "string",
      label: "Sort Direction",
      description: "Direction to sort results.",
      optional: true,
      options: [
        {
          label: "Ascending",
          value: "asc",
        },
        {
          label: "Descending",
          value: "desc",
        },
      ],
    },
    includePerformers: {
      propDefinition: [
        ticketsauce,
        "includePerformers",
      ],
    },
  },
  async run({ $ }) {
    const params = {
      partner_id: this.partnerId,
      organization_id: this.organizationId,
      start_after: this.startAfter,
      end_before: this.endBefore,
      active_only: String(this.activeOnly),
      privacy_type: this.privacyType,
      sort_by: this.sortBy,
      sort_dir: this.sortDir,
      include_performers: String(this.includePerformers),
    };
    return this.ticketsauce.listEvents($, {
      params,
    });
  },
};

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
TicketSauce	`ticketsauce`	`app`	This component uses the TicketSauce app.
Partner ID	`partnerId`	`string`	Including this ID will limit the result set to the specific partner.
Organization ID	`organizationId`	`string`	Including this ID will limit the result set to the specific organization.
Start After	`startAfter`	`string`	Only retrieve events that start AFTER the specified UTC date (format: `YYYY-MM-DD`).
End Before	`endBefore`	`string`	Only retrieve events that end BEFORE the specified UTC date (format: `YYYY-MM-DD`).
Active Only	`activeOnly`	`boolean`	Leaving this as true will restrict retrieved events to only 'active' events. Setting to false will allow the retrieval of both active and inactive events.
Privacy Type	`privacyType`	`string`	Select a value from the drop down menu:`{ "label": "Public events only", "value": "public" }{ "label": "All events (no restriction)", "value": "all" }{ "label": "Unlisted events only", "value": "unlisted" }`
Sort By	`sortBy`	`string`	Select a value from the drop down menu:`{ "label": "Event start date", "value": "date" }{ "label": "Event name", "value": "name" }{ "label": "City location", "value": "city" }`
Sort Direction	`sortDir`	`string`	Select a value from the drop down menu:`{ "label": "Ascending", "value": "asc" }{ "label": "Descending", "value": "desc" }`
Include Performers	`includePerformers`	`boolean`	If true, returns any associated performers/artists with the event.

Authentication#

TicketSauce uses OAuth authentication. When you connect your TicketSauce account, Pipedream will open a popup window where you can sign into TicketSauce and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any TicketSauce API.

Pipedream requests the following authorization scopes when you connect your account: