← Twitch

Block User with Twitch API

Pipedream makes it easy to connect APIs for Twitch and 700+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Block User with the Twitch API
No credit card required
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Configure the Block User action
    1. Connect your Twitch account
    2. Configure User ID
    3. Optional- Select a Source Context
    4. Optional- Select a Reason
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source 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.

Block User on Twitch
Description:Blocks a user; that is, adds a specified target user to your blocks list
Version:0.0.1
Key:twitch-block-user

Code

const common = require("../common.js");

module.exports = {
  ...common,
  name: "Block User",
  key: "twitch-block-user",
  description: "Blocks a user; that is, adds a specified target user to your blocks list",
  version: "0.0.1",
  type: "action",
  props: {
    ...common.props,
    user: {
      propDefinition: [
        common.props.twitch,
        "user",
      ],
      description: "User ID of the user to be blocked",
    },
    sourceContext: {
      type: "string",
      label: "Source Context",
      description: "Source context for blocking the user. Valid values: \"chat\", \"whisper\".",
      optional: true,
      options: [
        "chat",
        "whisper",
      ],
    },
    reason: {
      type: "string",
      label: "Reason",
      description: "Reason for blocking the user. Valid values: \"spam\", \"harassment\", or \"other\".",
      optional: true,
      options: [
        "spam",
        "harassment",
        "other",
      ],
    },
  },
  async run() {
    const params = {
      target_user_id: this.user,
      source_context: this.sourceContext,
      reason: this.reason,
    };
    const {
      status,
      statusText,
    } = await this.twitch.blockUser(params);
    return status == 204
      ? "User Blocked Successfully"
      : `${status} ${statusText}`;
  },
};

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.
LabelPropTypeDescription
TwitchtwitchappThis component uses the Twitch app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
User IDuserstring

User ID of the user to be blocked

Source ContextsourceContextstringSelect a value from the drop down menu:chatwhisper
ReasonreasonstringSelect a value from the drop down menu:spamharassmentother

Authentication

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

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

analytics:read:extensionsanalytics:read:gamesbits:readchannel:read:subscriptionsclips:edituser:edituser:edit:broadcastuser:read:broadcastuser:read:emailuser:read:blocked_usersuser:manage:blocked_userschannel:read:editorschannel:manage:videosuser:read:subscriptions

About Twitch

Live streaming platform for gamers

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday