actionPOSTv1.0.0
Ban user
Restricts user activity either in specific channel or globally
actionPOSTv1.0.0
Check push
Sends a test message via push, this is a test endpoint to verify your push settings
actionPOSTv1.0.0
Check SQS
Validates Amazon SQS credentials
actionPOSTv1.0.0
Commit message
Commits a pending message, which will make it visible in the channel
actionGETv1.0.0
Connect (WebSocket)
Establishes WebSocket connection for user
actionPOSTv1.0.0
Create a call
Creates a call
actionPOSTv1.0.0
Create block list
Creates a new application blocklist, once created the blocklist can be used by any channel type
actionPOSTv1.0.0
Create campaign
Creates a new campaign
actionPOSTv1.0.0
Create channel type
Creates new channel type
actionPOSTv1.0.0
Create command
Creates custom chat command
actionPOSTv1.0.0
Create device
Adds a new device to a user, if the same device already exists the call will have no effect
actionPOSTv1.0.0
Create guest
Creates guest user
actionPOSTv1.0.0
Create role
Creates custom role
actionPOSTv1.0.0
Create segment
Create a segment
actionPOSTv1.0.0
Deactivate user
Deactivates user with possibility to activate it back
actionPOSTv1.0.0
Deactivate users
Deactivate users in batches
actionDELETEv1.0.0
Delete a push provider
Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint
actionDELETEv1.0.0
Delete block list
Deletes previously created application blocklist
actionDELETEv1.0.0
Delete campaign
Delete a campaign
actionDELETEv1.0.0
Delete channel
Deletes channel
actionDELETEv1.0.0
Delete channel type
Deletes channel type
actionDELETEv1.0.0
Delete command
Deletes custom chat command
actionDELETEv1.0.0
Delete device
Deletes device
actionDELETEv1.0.0
Delete file
Deletes previously uploaded file
actionDELETEv1.0.0
Delete image
Deletes previously uploaded image
actionDELETEv1.0.0
Delete message
Deletes message
actionDELETEv1.0.0
Delete reaction
Removes user reaction from the message
actionDELETEv1.0.0
Delete role
Deletes custom role
actionDELETEv1.0.0
Delete segment
Delete a segment
actionDELETEv1.0.0
Delete user
Deletes user and optionally all their belongings. The Endpoint is deprecated, please use 'Delete Users' endpoint instead
actionPOSTv1.0.0
Delete Users
Deletes users and optionally all their belongings asynchronously.
actionPOSTv1.0.0
Deletes channels asynchronously
Allows to delete several channels at once asynchronously
actionPOSTv1.0.0
Flag
Reports message or user for review by moderators
actionGETv1.0.0
Get App Settings
This method returns the application settings
actionGETv1.0.0
Get block list
Returns block list by given name
actionGETv1.0.0
Get channel type
Gets channel type
actionGETv1.0.0
Get command
Returns custom command by its name
actionGETv1.0.0
Get many messages
Returns list messages found by IDs
actionGETv1.0.0
Get message
Returns message by ID
actionGETv1.0.0
Get OG
Get an OpenGraph attachment for a link
actionPOSTv1.0.0
Get or create channel (type, id)
This method creates a channel or returns an existing one with matching attributes
actionPOSTv1.0.0
Get or create channel (type)
This method creates a channel or returns an existing one with matching attributes
actionGETv1.0.0
Get permission
Gets custom permission
actionGETv1.0.0
Get rate limits
Get rate limits usage and quotas
actionGETv1.0.0
Get reactions
Returns list of reactions of specific message
actionGETv1.0.0
Get replies
Returns replies (thread) of the message
actionGETv1.0.0
Get status of a task
Gets status of a task
actionPOSTv1.0.0
Hide channel
Marks channel as hidden for current user
actionGETv1.0.0
List block lists
Returns all available block lists
actionGETv1.0.0
List channel types
Lists all available channel types
actionGETv1.0.0
List commands
Returns all custom commands
actionGETv1.0.0
List devices
Returns all available devices
actionGETv1.0.0
List permissions
Lists all available permissions
actionGETv1.0.0
List push providers
List details of all push providers.
actionGETv1.0.0
List roles
Lists all available roles
actionGETv1.0.0
Long Poll (Transport)
WebSocket fallback transport endpoint
actionPOSTv1.0.0
Mark channels as read
Marks channels as read up to the specific message. If no channels is given, mark all channel as read
actionPOSTv1.0.0
Mark read
Marks channel as read up to the specific message
actionPOSTv1.0.0
Mark unread
Marks channel as unread from a specific message
actionPOSTv1.0.0
Mute channel
Mutes channel for user
actionPOSTv1.0.0
Mute user
Mutes one or several users
actionPUTv1.0.0
Partially message update
Updates certain fields of the message
actionPATCHv1.0.0
Partially update channel
Updates certain fields of the channel
actionPATCHv1.0.0
Partially update user
Updates certain fields of the user
actionGETv1.0.0
Query Banned Users
Find and filter channel scoped or global user bans
actionGETv1.0.0
Query campaigns
Query campaigns
actionPOSTv1.0.0
Query channels
Query channels with filter query
actionGETv1.0.0
Query members
Find and filter channel members
actionGETv1.0.0
Query Message Flags
Find and filter message flags
actionGETv1.0.0
Query recipients
Query recipients
actionGETv1.0.0
Query segments
Query segments
actionGETv1.0.0
Query users
Find and filter users
actionPOSTv1.0.0
Reactivate user
Activates user who's been deactivated previously
actionPOSTv1.0.0
Reactivate users
Reactivate users in batches
actionPOSTv1.0.0
Restore users
Restore soft deleted users
actionPOSTv1.0.0
Run message command action
Executes message command action with given parameters
actionGETv1.0.0
Search messages
Search messages across channels
actionPOSTv1.0.0
Send event
Sends event to the channel
actionPOSTv1.0.0
Send new message
Sends new message to the specified channel
actionPOSTv1.0.0
Send reaction
Sends reaction to specified message
actionPOSTv1.0.0
Send user event
Sends a custom event to a user
actionPOSTv1.0.0
Show channel
Shows previously hidden channel
actionPOSTv1.0.0
Stop watching channel
Call this method to stop receiving channel events
actionPOSTv1.0.0
Sync
Returns all events happened since client disconnect in specified channels
actionPOSTv1.0.0
Test campaign
Test a campaign
actionPOSTv1.0.0
Translate message
Translates message to a given language using automated translation software
actionPOSTv1.0.0
Truncate channel
Truncates channel
actionPOSTv1.0.0
Unflag
Removes previously created user or message flag
actionPOSTv1.0.0
Unmute channel
Unmutes channel for user
actionPOSTv1.0.0
Unmute user
Unmutes previously muted user
actionPATCHv1.0.0
Update App Settings
This method updates one or more application settings
actionPUTv1.0.0
Update block list
Updates contents of the block list
actionPUTv1.0.0
Update campaign
Update an existing campaign
actionPOSTv1.0.0
Update channel
Change channel data
actionPUTv1.0.0
Update channel type
Updates channel type
actionPUTv1.0.0
Update command
Updates custom chat command
actionPOSTv1.0.0
Update message
Updates message with new data
actionPUTv1.0.0
Update segment
Update an existing segment
actionPOSTv1.0.0
Upsert a push provider
Upsert a push provider for v2 with multi bundle/package support
actionPOSTv1.0.0
Upsert users
Update or create users in bulk
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec