Rumatadocs
Browse documentation

Connector operations and every input field

Look up the operation names, required fields, examples, credentials, and request details in Rumata’s seeded connector catalog.

Step-by-step guidance.

Before you start

  • Open the named screen in Rumata. Available controls may depend on your account, permissions, and resource state.

Using this catalog

Open Add step in a workflow, choose a service, then choose its operation. This reference covers the seeded catalog; the server supplies the live list, so available connectors can change. All fields remain part of the graph draft until Save. Running the workflow sends the request and can change data in the external service.

ControlWhat it does
Operation choiceSelect the service task. Its fields appear in the step inspector.
Required marker / example placeholderComplete required inputs. An example in an empty field is not an actual configured value.
ƒx / key iconUse an expression for a request-body field or a saved secret where the key icon is offered.
Add a step groups triggers, connectors, activities, and control nodes. This reference capture uses a separate example factory. Select a step to review its configuration before adding it.

Echo (Postman)

A test API that returns a copy of your request and works without authentication or setup.

ControlWhat it does
Send echoTest a connector by sending a JSON body with POST and receiving it back. Complete the fields below, then save and run the workflow.
Send echo → MessageRequired. Enter the message to send. Placeholder example (not saved): Hello from Rumata.
Send echo → TitleOptional. Enter the title. Placeholder example (not saved): optional.
Get with querySend a GET request and receive the query parameters under `args`. Complete the fields below, then save and run the workflow.
Get with query → QueryOptional. Enter the query. Placeholder example (not saved): anything.

Slack

Post messages and read channels via Slack's Web API.

ControlWhat it does
Bot tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bearer xoxb-….
Send messagePost a message to a channel (chat.postMessage). Complete the fields below, then save and run the workflow.
Send message → ChannelRequired. Enter the channel. Placeholder example (not saved): #general or C0123.
Send message → TextRequired. Enter the text to send. Placeholder example (not saved): Hello :wave:.
List channelsList the workspace's conversations (conversations.list). Complete the fields below, then save and run the workflow.
List channels → LimitOptional. Set the limit. Placeholder example (not saved): 100.

GitHub

Create issues and read repositories on the GitHub REST API.

ControlWhat it does
Personal access tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bearer ghp_….
Create issueOpen an issue on a repository. Complete the fields below, then save and run the workflow.
Create issue → OwnerRequired. Enter the owner. Placeholder example (not saved): octocat.
Create issue → RepositoryRequired. Enter the repository. Placeholder example (not saved): hello-world.
Create issue → TitleRequired. Enter the title. Placeholder example (not saved): Found a bug.
Create issue → BodyOptional. Enter the body. Placeholder example (not saved): Describe the issue….
Get repositoryFetch a repository's metadata. Complete the fields below, then save and run the workflow.
Get repository → OwnerRequired. Enter the owner. Placeholder example (not saved): octocat.
Get repository → RepositoryRequired. Enter the repository. Placeholder example (not saved): hello-world.

Telegram

Send messages through your Telegram bot.

ControlWhat it does
Send messageSend a text message to a chat as your bot. Complete the fields below, then save and run the workflow.
Send message → Bot tokenRequired. Enter the token from @BotFather. Use a project secret in production. Placeholder example (not saved): 123456789:AAH….
Send message → Chat IDRequired. Enter your numeric chat ID from @userinfobot or the bot's getUpdates. Placeholder example (not saved): 123456789.
Send message → MessageRequired. Enter the message to send. Placeholder example (not saved): Hello from Rumata 👋.
Get updatesPoll for new incoming messages (long-polling, tunnel-free). Pass offset = last update_id + 1 to acknowledge. Complete the fields below, then save and run the workflow.
Get updates → Bot tokenRequired. Enter the token from @BotFather, using the same token as Send message. Placeholder example (not saved): 123456789:AAH….
Get updates → OffsetOptional. Acknowledge all updates below this value, or leave it blank to read all pending updates. Placeholder example (not saved): (last update_id + 1).
Get updates → LimitOptional. Set the limit. Placeholder example (not saved): 10.

Discord

Send messages to a channel as your Discord bot.

ControlWhat it does
Bot tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bot MTA….
Send channel messagePost a message to a channel (the bot must be in the server). Complete the fields below, then save and run the workflow.
Send channel message → Channel IDRequired. Enter the channel ID. Placeholder example (not saved): 1029384756.
Send channel message → MessageRequired. Enter the message to send. Placeholder example (not saved): Hello from Rumata 👋.

Notion

Create pages and query databases in your Notion workspace.

ControlWhat it does
Integration tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bearer secret_….
Query databaseReturn the pages (rows) of a database. Complete the fields below, then save and run the workflow.
Query database → Database IDRequired. Enter the database ID. Placeholder example (not saved): 32-char id.
Query database → Page sizeOptional. Set the page size. Placeholder example (not saved): 10.

SendGrid

Send transactional email through SendGrid.

ControlWhat it does
API keyEnter the service credential, preferably using the project-secret selector. Expected format: Bearer SG.….
Send emailSend a single email. Use the ƒx toggle on a field to map dynamic data. Complete the fields below, then save and run the workflow.
Send email → PersonalizationsRequired. Toggle ƒx and paste the JSON array, e.g. [{"to":[{"email":"to@x.com"}]}]. Placeholder example (not saved): [{"to":[{"email":"to@x.com"}]}].
Send email → FromRequired. Toggle ƒx and paste {"email":"me@x.com"}. Placeholder example (not saved): {"email":"me@x.com"}.
Send email → SubjectRequired. Enter the subject. Placeholder example (not saved): Hello.
Send email → ContentRequired. Toggle ƒx and paste [{"type":"text/plain","value":"Hi"}]. Placeholder example (not saved): [{"type":"text/plain","value":"Hi"}].

OpenAI

Call OpenAI's chat completions API.

ControlWhat it does
API keyEnter the service credential, preferably using the project-secret selector. Expected format: Bearer sk-….
Chat completionGenerate a chat completion. Toggle ƒx on Messages to map dynamic input. Complete the fields below, then save and run the workflow.
Chat completion → ModelRequired. Specify the model. Placeholder example (not saved): gpt-5.6-terra.
Chat completion → MessagesRequired. Toggle ƒx and paste the messages array. Placeholder example (not saved): [{"role":"user","content":"Hi"}].

Anthropic

Call the Anthropic Claude Messages API.

ControlWhat it does
API keyEnter the service credential, preferably using the project-secret selector. Expected format: sk-ant-….
Create messageGenerate a Claude response. Toggle ƒx on Messages to map dynamic input. Complete the fields below, then save and run the workflow.
Create message → ModelRequired. Specify the model. Placeholder example (not saved): claude-sonnet-5.
Create message → Max tokensRequired. Set the maximum number of tokens. Placeholder example (not saved): 1024.
Create message → MessagesRequired. Toggle ƒx and paste the messages array. Placeholder example (not saved): [{"role":"user","content":"Hi"}].

Airtable

Read and create records in an Airtable base.

ControlWhat it does
Personal access tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bearer pat….
Create recordAdd a record to a table. Complete the fields below, then save and run the workflow.
Create record → Base IDRequired. Enter the base ID. Placeholder example (not saved): app….
Create record → TableRequired. Enter the table. Placeholder example (not saved): Tasks.
Create record → FieldsRequired. Toggle ƒx and paste a {field: value} object. Placeholder example (not saved): {"Name":"New task"}.
List recordsList the records in a table. Complete the fields below, then save and run the workflow.
List records → Base IDRequired. Enter the base ID. Placeholder example (not saved): app….
List records → TableRequired. Enter the table. Placeholder example (not saved): Tasks.
List records → Max recordsOptional. Set the maximum number of records. Placeholder example (not saved): 10.

HubSpot

Create CRM contacts in HubSpot.

ControlWhat it does
Private app tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bearer pat-….
Create contactCreate a contact record. Complete the fields below, then save and run the workflow.
Create contact → PropertiesRequired. Toggle ƒx and paste a {property: value} object. Placeholder example (not saved): {"email":"a@b.com","firstname":"A"}.

Stripe

Read payments data from Stripe.

ControlWhat it does
Secret keyEnter the service credential, preferably using the project-secret selector. Expected format: Bearer sk_test_….
List customersList your Stripe customers. Complete the fields below, then save and run the workflow.
List customers → LimitOptional. Set the limit. Placeholder example (not saved): 10.
Get balanceRetrieve your current Stripe balance. Complete the fields below, then save and run the workflow.

GitLab

Create issues on GitLab (gitlab.com SaaS).

ControlWhat it does
Access tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bearer glpat-….
Create issueOpen an issue on a project (URL-encode the project path or use its numeric id). Complete the fields below, then save and run the workflow.
Create issue → Project IDRequired. Enter the project ID. Placeholder example (not saved): 12345 or group%2Fproject.
Create issue → TitleRequired. Enter the title. Placeholder example (not saved): Found a bug.
Create issue → DescriptionOptional. Enter the description. Placeholder example (not saved): Details….

Jira

Create issues in Jira Cloud. Authenticate with Basic base64(email:apiToken).

ControlWhat it does
Basic credentialEnter the service credential, preferably using the project-secret selector. Expected format: Basic <base64 email:token>.
Create issueCreate a Jira issue. Toggle ƒx on Fields to pass the full ADF fields object. Complete the fields below, then save and run the workflow.
Create issue → SiteRequired. The subdomain of your Jira Cloud site (https://<site>.atlassian.net). Placeholder example (not saved): your-domain.
Create issue → FieldsRequired. Toggle ƒx and paste the Jira fields object. Placeholder example (not saved): {"project":{"key":"ABC"},"summary":"Hi","issuetype":{"name":"Task"}}.

Shopify

Read your Shopify store's data (Admin API).

ControlWhat it does
Admin API tokenEnter the service credential, preferably using the project-secret selector. Expected format: shpat_….
Get shopFetch the store's metadata. Complete the fields below, then save and run the workflow.
Get shop → ShopRequired. The subdomain of your store (https://<shop>.myshopify.com). Placeholder example (not saved): my-store.

Asana

Create tasks in Asana.

ControlWhat it does
Personal access tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bearer 1/….
Create taskCreate a task in a project or workspace. Complete the fields below, then save and run the workflow.
Create task → Task dataRequired. Toggle ƒx and paste the Asana task data object. Placeholder example (not saved): {"name":"New task","workspace":"123"}.

Trello

Create cards on a Trello board. Authenticate with key + token query parameters.

ControlWhat it does
Create cardAdd a card to a list. Complete the fields below, then save and run the workflow.
Create card → API keyRequired. Enter the API key. Placeholder example (not saved): your-key.
Create card → API tokenRequired. Enter the API token. Placeholder example (not saved): your-token.
Create card → List IDRequired. Enter the list ID. Placeholder example (not saved): 5abbe4b….
Create card → Card nameRequired. Enter the card name. Placeholder example (not saved): New card.

Google Sheets

Append rows to a Google Sheet. Authenticate with an OAuth2 access token.

ControlWhat it does
Access tokenEnter the service credential, preferably using the project-secret selector. Expected format: Bearer ya29.….
Append rowAppend a row of values to a sheet range. Complete the fields below, then save and run the workflow.
Append row → Spreadsheet IDRequired. Enter the spreadsheet ID. Placeholder example (not saved): 1AbC….
Append row → RangeRequired. Set the range. Placeholder example (not saved): Sheet1!A1.
Append row → Value input optionOptional. Set the value input option. Placeholder example (not saved): RAW.
Append row → ValuesRequired. Toggle ƒx and paste a 2-D array of cell values. Placeholder example (not saved): [["a","b","c"]].

Supabase

Read and write rows via your Supabase project's REST (PostgREST) API.

ControlWhat it does
API key (service role or anon)Enter the service credential, preferably using the project-secret selector. Expected format: eyJhbGci… (Project Settings → API).
Select rowsRead rows from a table (PostgREST). Use Select to pick columns and Filter for PostgREST operators. Complete the fields below, then save and run the workflow.
Select rows → Project refRequired. Your project ref — the subdomain of <ref>.supabase.co. Placeholder example (not saved): abcdefgh.
Select rows → TableRequired. Enter the table. Placeholder example (not saved): todos.
Select rows → SelectOptional. Set the select value. Placeholder example (not saved): *.
Select rows → LimitOptional. Set the limit. Placeholder example (not saved): 10.
Insert rowInsert a row (or rows) into a table. Toggle ƒx on Row to map dynamic data, or paste a JSON object. Complete the fields below, then save and run the workflow.
Insert row → Project refRequired. Enter the project ref. Placeholder example (not saved): abcdefgh.
Insert row → TableRequired. Enter the table. Placeholder example (not saved): todos.
Insert row → RowRequired. The row object (sent as the bare PostgREST body). Toggle ƒx to map dynamic data, e.g. $ or [$]. Placeholder example (not saved): {"task":"Buy milk","done":false}.