Instant Connections

Adds a word or phrase to the broadcaster’s list of blocked terms.

Adds a moderator to the broadcaster’s chat room.

Adds the specified user as a VIP in the broadcaster’s channel.

Adds a suspicious user status to a chatter on the broadcaster’s channel.

BETA Allows a previously invited user to be assigned a slot within the active Guest Star session.

Bans a user from participating in a broadcaster’s chat room or puts them in a timeout.

Blocks the specified user from interacting with or having contact with the broadcaster.

Cancel a pending raid.

Checks whether AutoMod would flag the specified message for review.

Checks whether the user subscribes to the broadcaster’s channel.

Adds a single or recurring broadcast to the broadcaster’s streaming schedule.

Starts Twitch's asynchronous clip-creation process for a live stream. A 202 response is acceptance, not completed creation. Use GET_CLIPS with the returned ID to verify; if it is still absent after 60 seconds, Twitch says to assume creation failed.

Starts Twitch's asynchronous clip-creation process from a VOD. A 202 response is acceptance, not completed creation. Use GET_CLIPS with the returned ID to verify completion.

Creates a Custom Reward in the broadcaster’s channel.

Creates one of the 78 supported EventSub type/version combinations over WebSocket using user OAuth. The selected type and version determine its documented conditional OAuth scope; the eight unscoped types require no scope.

BETA Programmatically creates a Guest Star session on behalf of the broadcaster.

Creates a poll that viewers in the broadcaster’s channel can vote on.

Create a Channel Points Prediction.

Adds a marker to a live stream.

Deletes a broadcast from the broadcaster’s streaming schedule.

Removes a single chat message or all chat messages from the broadcaster’s chat room.

Deletes a custom reward that the broadcaster created.

Deletes an EventSub subscription.

BETA Revokes a previously sent invite for a Guest Star session.

BETA Allows a caller to remove a slot assignment from a user participating in an active Guest Star session.

Deletes one or more videos.

BETA Programmatically ends a Guest Star session on behalf of the broadcaster.

End an active poll.

Locks, resolves, or cancels a Channel Points Prediction.

Returns the next ad's scheduled time and duration, available snooze count and refresh time, prior ad time, and remaining pre-roll-free time.

Gets the broadcaster’s AutoMod settings.

Gets one cursor page of users that the broadcaster banned or put in a timeout. Follow the returned cursor to retrieve the full collection.

Gets the Bits leaderboard for the authenticated broadcaster.

Gets the broadcaster’s list of non-private, blocked words or phrases.

Gets a list of users that subscribe to the specified broadcaster.

Gets the broadcaster’s list of custom chat badges.

Gets the broadcaster’s list editors.

Gets the broadcaster’s list of custom emotes.

Gets a list of users that follow the specified broadcaster. You can also use this endpoint to see whether a specific user follows the broadcaster.

BETA Gets the channel settings for configuration of the Guest Star feature for a particular host.

Gets the broadcaster’s streaming schedule as an iCalendar .

Gets information about one or more channels.

Gets the broadcaster’s streaming schedule.

Gets the list of Twitch teams that the broadcaster is a member of.

Gets information about the broadcaster’s active charity campaign.

Gets the list of donations that users have made to the broadcaster’s active charity campaign.

Gets the broadcaster’s chat settings.

Gets the list of users that are connected to the broadcaster’s chat session.

Gets a list of Cheermotes that users can use to cheer Bits.

Gets clips selected by exactly one broadcaster ID, game ID, or list of clip IDs.

Provides URLs to download the video file(s) for the specified clips.

Gets information about Twitch content classification labels.

Gets the broadcaster’s list of active goals.

Gets a list of custom Power-ups that the specified broadcaster created.

Gets a list of custom rewards that the specified broadcaster created.

Gets a list of redemptions for a custom reward.

Gets Drops entitlements granted to the user in the OAuth token, optionally filtered by entitlement ID, game, or fulfillment status.

Gets emotes for one or more specified emote sets.

Lists WebSocket EventSub subscriptions associated with the connected user OAuth token.

Gets an analytics report for one or more extensions.

Gets a list of broadcasters that are streaming live and have installed or activated the extension.

Gets a list of broadcasters that the specified user follows. You can also use this endpoint to see whether a user follows a specific broadcaster.

Gets the list of broadcasters that the user follows and that are streaming live.

Gets an analytics report for one or more games.

Gets information about specified games.

Gets Twitch’s list of chat badges.

Gets all global emotes.

BETA Provides the caller with a list of pending invites to a Guest Star session.

BETA Gets information about an ongoing Guest Star session for a particular channel.

Gets the status of a Hype Train for the specified broadcaster.

Gets a list of channels that the specified user has moderator privileges in.

Gets all users allowed to moderate the broadcaster’s chat room.

Gets the currently pinned message for the broadcaster’s chat room.

Gets a list of polls that the broadcaster created.

Gets a list of Channel Points Predictions that the broadcaster created.

Gets information about a released extension.

Retrieves the active shared chat session for a channel.

Gets the broadcaster’s Shield Mode activation status.

SENSITIVE: retrieves the channel's raw stream key, which grants the ability to broadcast as the channel. Use only when explicitly required; never log, quote, persist, or disclose the output. This is non-mutating and therefore uses the strongest available read-only ability hint.

Gets markers from either a user's most recent stream or one specified VOD; provide exactly one selector.

Gets a list of all streams.

Gets one Twitch team by exactly one team name or team ID.

Gets games and categories ranked by current viewer count on Twitch.

Gets a list of unban requests for a broadcaster’s channel.

Gets the active extensions that the broadcaster has installed for each configuration.

Gets the list of users that the broadcaster has blocked.

Gets the color used for the user’s name in chat.

Retrieves emotes available to the user across all channels.

Gets a list of all extensions (both active and inactive) that the broadcaster has installed.

Gets information about one or more users. With no id or login selectors, returns the user represented by the access token.

Gets published videos selected by exactly one list of video IDs, broadcaster ID, or game ID.

Gets a list of the broadcaster’s VIPs.

Allows or denies one message that AutoMod held for review.

Updates a channel’s properties.

Pins a chat message to the specified broadcaster’s chat room.

Removes the word or phrase from the broadcaster’s list of blocked terms.

Removes a moderator from the broadcaster’s chat room.

Removes the specified user as a VIP in the broadcaster’s channel.

Remove a suspicious user status from a chatter on broadcaster’s channel.

Resolves an unban request by approving or denying it.

Gets the games or categories that match the specified query.

Gets the channels that match the specified query and have streamed content within the past 6 months.

Sends a Shoutout to the specified broadcaster.

Sends an announcement to the broadcaster’s chat room using user OAuth. In a Shared Chat session, the announcement is sent to all channels in the session, including the source channel.

Sends a message to the broadcaster’s chat room using user OAuth and fails if Twitch reports that it was dropped. In a Shared Chat session, user OAuth sends the message to all channels in the session, including the source channel. Set reply_parent_message_id to reply or pin to send and immediately pin the message.

BETA Sends an invite to a specified guest on behalf of the broadcaster for a Guest Star session in progress.

Requests delivery of a whisper message to the specified user. Twitch may silently drop a whisper while still returning HTTP 204, so a successful response does not confirm delivery.

Pushes back the timestamp of the upcoming automatic mid-roll ad by 5 minutes.

Initiates a pending raid of another channel. The raid occurs only when the broadcaster clicks Raid Now or the 90-second countdown expires; confirm completion separately through the Channel Raid event.

Starts a commercial for a broadcaster that is a Twitch partner or affiliate and is currently streaming live. The broadcaster must invoke this action for itself, so broadcaster_id must match the user in the OAuth token.

Removes the ban or timeout that was placed on the specified user.

Removes the user from the broadcaster’s list of blocked users.

Unpins a pinned chat message from the broadcaster’s chat room.

Updates the broadcaster’s AutoMod settings.

BETA Updates Guest Star channel settings; regenerating browser sources immediately invalidates all previously configured browser sources.

Updates the broadcaster’s schedule settings, such as scheduling a vacation.

Updates a scheduled broadcast segment. Changes to a recurring segment apply to every segment in its series.

Updates the broadcaster’s chat settings.

Updates a custom reward. Only the app that created the reward may update it.

Updates the Drop entitlement’s fulfillment status.

BETA Allows a user to update the assigned slot for a particular user within the active Guest Star session.

BETA Allows a user to update slot settings for a particular guest within a Guest Star session.

Updates the duration of a pinned chat message.

Updates a redemption’s status. Only an UNFULFILLED redemption may be updated, and only the app that created the reward may update it.

Activates or deactivates the broadcaster’s Shield Mode.

Updates the user’s information.

Updates the color used for the user’s name in chat.

Updates an installed extension’s information. If the same extension is activated under multiple extension types, the last write wins, but write order is not guaranteed; avoid activating one extension under multiple types.

Warns a user in the specified broadcaster’s chat room, preventing them from chat interaction until the warning is acknowledged. A new warning replaces any existing warning for that user in the channel.

Add one or more gifts (donations) to an existing gift batch in Blackbaud Raiser's Edge NXT. Use this tool when you need to: - Append new gifts to an open batch for later processing - Batch multiple donations together before committing them - Add gifts with detailed information (payments, splits, custom fields) Prerequisites: - The batch must already exist (use a create batch action first if needed) - The batch must be in "open" status (not committed) - You need the batch_id (system record ID) and constituent_id (donor ID) for each gift Note: This action returns response details for all HTTP status codes (including errors). Check the status_code field in the response to determine success (200) vs errors (4xx/5xx).

Retrieves comprehensive gift details from Blackbaud Raiser's Edge NXT by gift ID. Use this tool when you need to fetch detailed information about a specific gift including: - Gift amount and currency - Donor/constituent information - Gift type and status - Important dates (gift date, post date) - Associated metadata and custom fields The gift_id is the unique system record ID (integer) that identifies the gift in Raiser's Edge NXT.

Retrieves comprehensive membership details from Blackbaud Raiser's Edge NXT by member junction ID. Fetches detailed information about a specific membership including program name, category/subcategory, membership status and standing (Active, Lapsed), start/expiration dates, dues information, and associated constituent ID. Requires a valid member_junction_id (GUID) that uniquely identifies a membership junction record linking a constituent to a membership program in Raiser's Edge NXT. Returns error information in the response object for graceful error handling in agent workflows.

Retrieves payment transaction details from Blackbaud SKY Payments API. Use this to check transaction status, amounts, payment methods, and error details. Transaction IDs come from payment processing endpoints, checkout callbacks, batch operations, or webhook notifications. Requires: Payments API subscription key (Bb-Api-Subscription-Key) and OAuth Bearer token. This retrieves existing transactions; it does not process new payments.

Tool to interact with Blackbaud OneRoster OAuth2 base endpoints. Use to fetch OpenID configuration (/.well-known/openid-configuration), JWKS key set (publickeys), or obtain an access token via the client credentials grant. Ensure client credentials are configured before using the token operation.

Tool to get brand details by brand ID. Use after obtaining the brand identifier.

Tool to list all brands in the account. Use after confirming account is authenticated.

Tool to create a brand-scoped custom field. Use when you need to define and register a new custom field for a specific brand.

Tool to edit an existing custom field. Use when you need to update a custom field's properties after creation.

Tool to list documents sent on behalf of users. Use when fetching and filtering documents you've sent or on behalf of others.

Tool to edit a draft or sent document. Use when updating files, recipients, or document settings before finalizing the document.

Tool to extend a document's expiry date. Use before signing to prolong a document's deadline.

Tool to list documents in My Documents with filters. Use when you need to fetch and filter documents based on various criteria.

Tool to remove authentication from a document. Use when you need to disable signer authentication on an existing document before the signing process.

Tool to send a document for eSignature. Use when you need to deliver documents to recipients for signing.

Tool to list team documents. Use when a team or account admin needs to retrieve all team documents with optional filters.

Tool to create an embedded request link. Use after specifying title and signers to generate an embeddable URL for in-app document preparation and sending.

Helper action to upload a file to R2 temp via the Xava file pipeline, returning a key that can be passed to FileUploadable fields in other actions (e.g., BrandLogo in brand create).

Tool to get remaining BoldSign API credits count. Use after authenticating your BoldSign account.

Tool to attach a file from a provided URL to a task. The file will be downloaded and attached asynchronously. Use when you need to add a file attachment to a task from a URL source.

Tool to create a new comment on a DART task. Use when you need to add feedback, notes, or discussion to a specific task. Supports markdown formatting and threaded replies via parentId.

Tool to add a time tracking entry to a DART task. Use when you need to record time spent on a specific task. The finishedAt timestamp must be after startedAt.

Tool to create a new doc in Dart. Use when you need to record a new document that the user intends to write down. By default, the created doc will be in the Docs folder unless a specific folder is specified.

Tool to create a new task in DART with title and optional metadata. Use when you need to add a task to a workspace.

Tool to move an existing doc to the trash where it can be recovered if needed. Use when you need to delete a doc without permanently removing it.

Tool to delete an existing task in Dart by moving it to trash. Use when a task needs to be removed but can be recovered later.

Tool to retrieve workspace configuration including dartboards, folders, types, statuses, and more. Use when you need to understand available options in the workspace.

Tool to retrieve an existing doc with metadata and content. Use when you need to access a specific document's details including title, folder, and text content.

Tool to retrieve an existing task with full details including title, dartboard, status, and description. Use when you need to fetch complete information about a specific task.

Tool to list comments for a task with filtering options. Use when you need to retrieve comments on a specific task. Supports filtering by author, text content, date range, and pagination. Can be ordered by date or hierarchical thread structure.

Tool to list docs with filtering and search capabilities. Use when you need to retrieve documents from DART with filters like folder, title, text content, or full-text search. Supports pagination and custom ordering by creation date, update date, or title.

Tool to search help center articles by semantic similarity to query. Use when you need to find relevant help articles based on a short search query (1-5 words). Returns up to two most relevant articles.

Tool to list tasks with powerful filtering options. Use when you need to retrieve tasks from DART with filters like dartboard, status, assignee, tags, priority, dates, or completion state. Supports pagination and custom ordering.

Tool to move a task to a specific position within its dartboard. Use when you need to reorder tasks in a list. Specify either afterTaskId or beforeTaskId to position the task.

Tool to retrieve a skill by its exact title from the workspace. Use when you need to find details about a specific skill including its ID and instructions.

Tool to update an existing doc in Dart. Use when you need to modify a document's title, folder location, or content. Any properties not specified will remain unchanged.

Tool to update an existing task in DART with new properties. Use when you need to modify a task's title, status, assignees, or other attributes. Only properties specified in the request will be updated.