Actions reference

Everything an AI agent can do in Rinhelp. This page is generated from Rinhelp itself.

An AI agent acts for the teammate who connected it, with no more authority than that teammate's role. Actions only a teammate can run, such as creating an API key, are left out.

Retry without repeating work

Some actions need an idempotencyKey: a unique ID for one request. If a request may have timed out, send it again with the same key and the same inputs, and Rinhelp returns the first result instead of doing the work twice. Use a new key for a new request.

Approval

An action marked Needs approval moves money or can't be undone. When an AI agent runs one, Rinhelp files an approval for a teammate to approve or reject, and the AI agent never decides it. Any teammate can decide, unless the action says an owner decides. See Approve actions.

account_whoami

Show who you are acting as: the workspace, your teammate account and your role.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

agent_list

List your own AI agents and whether each is revoked.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

agent_log

Show the latest actions an AI agent ran.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• agentId (required): The AI agent’s ID.

agent_revoke

Revoke an AI agent so it can no longer act. A teammate approves it in the app.

• Who can run it: Any teammate
• Needs approval: Yes
• Idempotency key: Not needed

Inputs:

• agentId (required): The AI agent’s ID.

agent_team

List every AI agent in the workspace (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

approval_show

Show an approval: who asked, for what and why, and how it was decided.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• approvalId (required): The approval’s ID.

article_create

Write a new draft article in the help center.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Required

Inputs:

• title (required): The article’s title.
• body: The article’s text, in Markdown.
• sectionId: The ID of the section it belongs to. Leave it empty for none.

article_delete

Delete an article for good. A teammate approves it in the app.

• Who can run it: Any teammate
• Needs approval: Yes
• Idempotency key: Not needed

Inputs:

• articleId (required): The article’s ID.

article_list

List the help center’s sections, in order, and its articles.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

article_publish

Publish an article so it is on the help center and in knowledge at once.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• articleId (required): The article’s ID.

article_read

Read an article, draft or published, with its Markdown text.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• articleId (required): The article’s ID.

article_unpublish

Turn a published article back into a draft, out of the help center and knowledge.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• articleId (required): The article’s ID.

article_update

Change an article’s title, text or section. A published article updates in knowledge at once.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• articleId (required): The article’s ID.
• title: The article’s title.
• body: The article’s text, in Markdown.
• sectionId: The ID of the section it belongs to. Leave it empty for none.

billing_buy_pack

Get a link to buy a top-up of 5,000 more AI replies. An AI agent gets a link to the Billing page, where an owner does it.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

billing_manage

Get a link to change the card, download invoices or cancel Pro. An AI agent gets a link to the Billing page, where an owner does it.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

billing_remove_branding

Remove branding for $49 a month on top of Pro. An AI agent gets a link to the Billing page, where an owner does it.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

billing_restore_branding

Show branding again and stop its $49 monthly charge. An AI agent gets a link to the Billing page, where an owner does it.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

billing_upgrade

Get a link to upgrade the workspace to Pro. An AI agent gets a link to the Billing page, where an owner does it.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

conversation_assign

Assign a conversation to a teammate (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• conversationId (required): The conversation’s ID.
• userId (required): The teammate’s user ID.

conversation_close

Close a conversation.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• conversationId (required): The conversation’s ID.

conversation_count

Count the open conversations: all of them, and the ones assigned to you.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

conversation_list

List conversations. Pick a view: mine, open, rin or closed. Waiting ones come first.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• view: mine (default), open, rin or closed.
• tag: Only conversations with this tag.
• priority: urgent or normal.
• assignee: Only conversations assigned to this teammate’s ID.
• cursor: The next value from the previous page.
• since: Only conversations with a message after this date and time.

conversation_note

Add a note only the team can see.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Required

Inputs:

• conversationId (required): The conversation’s ID.
• message (required): The note to add.

conversation_reply

Send a reply to the customer in a conversation.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Required

Inputs:

• conversationId (required): The conversation’s ID.
• message (required): The reply to send.

conversation_resend

Send a reply’s email to the customer again.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Required

Inputs:

• conversationId (required): The conversation’s ID.
• messageId (required): The message’s ID.

conversation_show

Show a conversation with its messages, notes and events.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• conversationId (required): The conversation’s ID.

conversation_triage

Set a conversation’s tags or priority.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• conversationId (required): The conversation’s ID.
• tags: The full list of tags.
• priority: urgent or normal.

email_domain_set

Start setting up the workspace’s own email domain.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

email_domain_show

Show the workspace’s own email domain and its setup records.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

email_domain_verify

Check whether the email domain’s records are in place.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

email_set_address

Choose the workspace’s email address.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• address (required): The email address to use.

email_show

Show the workspace’s email address and setup.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

email_test

Send a test email to check email works.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

get_started_show

Show which “Get started” steps the workspace has done (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

help_center_domain_add

Start serving the help center on a custom domain (owner only), such as help.example.com.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• domain (required): A subdomain you own, such as help.example.com.

help_center_domain_check

Check whether the help center’s custom domain works yet (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

help_center_domain_remove

Stop serving the help center on its custom domain (owner only). It moves back to its rinhelp.com address.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

help_center_show

Show the help center’s address, its custom domain, and whether it has a published article.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

help_center_update

Change the help center’s subdomain (owner only). Links to the old address stop working at once.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• subdomain (required): The new subdomain, such as acme for acme.rinhelp.com.

integration_disconnect

Disconnect Shopify or Stripe and delete its stored credentials. Rin and the team can no longer look up its orders or payments.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• kind (required): Which integration. One of shopify, stripe.

integration_show

Show which integrations the workspace has connected.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

knowledge_gap_list

List the customer questions Rin couldn't answer from knowledge, newest first, with their conversation.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• since: Only questions asked after this date and time. Leave it empty for the last 30 days.
• cursor: The next value from the previous page.

knowledge_read

Read a knowledge page’s text.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• pageId (required): The page’s ID, from a search.
• cursor: The nextCursor from the previous part, to keep reading.

knowledge_search

Search the workspace’s knowledge and return the best matching passages.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• query (required): What to look for.

profile_set_name

Change your name, which customers see when you reply.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• name (required): Your name.

profile_set_notifications

Turn assignment emails on or off for you.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• on (required): true to get emails. One of true, false.

profile_show

Show your name and whether you get an email when a conversation is assigned to you.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

section_create

Add a section to the end of the help center.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Required

Inputs:

• name (required): The section’s name.

section_delete

Delete a section. Its articles stay, without a section.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• sectionId (required): The section’s ID.

section_update

Rename a section, or move it to another place in the help center.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• sectionId (required): The section’s ID.
• name: The section’s new name.
• position: Its new place, counting from 1 for the first section.

shopify_connect

Connect a Shopify store with the Client ID and secret of an app made for it.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• shop (required): The store’s address, like your-store.myshopify.com.
• clientId (required): The app’s Client ID from the Shopify Dev Dashboard.
• clientSecret (required): The app’s secret from the Shopify Dev Dashboard.

shopify_order_cancel

Cancel an unfulfilled Shopify Order, refund it in full to its original payment, and restock its items. From an AI agent, it waits for a teammate to approve it in the app.

• Who can run it: Any teammate
• Needs approval: Yes
• Idempotency key: Required

Inputs:

• conversationId (required): The conversation the Order is about.
• orderNumber (required): The order number, like #1001.
• reason (required): Why, in a sentence the team will read.

shopify_order_find

Find Shopify orders by an order number, or else by the email of a conversation’s customer. Shows each order’s total, date, status, fulfillment, tracking and items.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• orderNumber: The order number, like #1001.
• conversationId: The conversation whose customer’s email to search by.

shopify_order_refund

Refund a Shopify order to its original payment, in full or a part by amount. From an AI agent, it waits for a teammate to approve it in the app.

• Who can run it: Any teammate
• Needs approval: Yes
• Idempotency key: Required

Inputs:

• conversationId (required): The conversation the Order is about.
• orderNumber (required): The order number, like #1001.
• reason (required): Why, in a sentence the team will read.
• amount: The amount in the store’s currency, like 24.50. Leave it out to refund all that is left.

source_add

Add a website for Rin to learn from.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• url (required): The website’s address.

source_list

List the websites Rin learns from, with their pages.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

source_refresh

Read a website again for new content.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• sourceId (required): The source’s ID.

source_remove

Remove a website from what Rin learns from.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• sourceId (required): The source’s ID.

stripe_connect

Connect Stripe with a restricted API key made for Rinhelp.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• apiKey (required): A restricted API key from Stripe, starting with rk_.

stripe_customer_find

Find Stripe customers by customer ID, email, invoice or receipt number, or else by the email of a conversation’s customer. Shows each one’s subscriptions with their renewal date, and recent invoices and payments.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• customerId: The Stripe customer ID, like cus_123.
• email: The customer’s email.
• number: An invoice or receipt number, like ABC-0001.
• conversationId: The conversation whose customer’s email to search by.

stripe_payment_refund

Refund a Stripe payment, in full or a part by amount. From an AI agent, it waits for a teammate to approve it in the app.

• Who can run it: Any teammate
• Needs approval: Yes
• Idempotency key: Required

Inputs:

• conversationId (required): The conversation the payment is about.
• paymentId (required): The payment’s ID from stripe_customer_find, like ch_123.
• reason (required): Why, in a sentence the team will read.
• amount: The amount in the payment’s currency, like 24.50. Leave it out to refund all that is left.

stripe_subscription_cancel

Cancel a Stripe subscription at the end of its current period, so it doesn’t renew. From an AI agent, it waits for a teammate to approve it in the app.

• Who can run it: Any teammate
• Needs approval: Yes
• Idempotency key: Required

Inputs:

• conversationId (required): The conversation the Subscription is about.
• subscriptionId (required): The Subscription’s ID from stripe_customer_find, like sub_123.
• reason (required): Why, in a sentence the team will read.

team_cancel

Cancel a pending invitation (Owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• invitationId (required): The invitation’s ID.

team_invite

Invite someone to the workspace by email (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• email (required): The email address to invite.

team_leave

Leave the workspace. A teammate approves it in the app.

• Who can run it: Any teammate
• Needs approval: Yes
• Idempotency key: Not needed

No inputs.

team_list

List the teammates and pending invitations.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

team_remove

Remove a teammate from the team. An owner approves it in the app.

• Who can run it: Owners
• Needs approval: Yes, an owner decides
• Idempotency key: Not needed

Inputs:

• userId (required): The teammate’s user ID, from team_list.

team_set_role

Make a teammate an owner, or an owner a teammate.

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• userId (required): The teammate’s user ID, from team_list.
• role (required): The new role. One of member, owner.

widget_preview

Ask Rin a question to see how it would answer a customer.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• question (required): The question to ask.

widget_regenerate_secret

Make a new chat widget secret (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

widget_remove_image

Remove the chat widget’s image (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

No inputs.

widget_show

Show the chat widget’s settings and install snippet.

• Who can run it: Any teammate
• Needs approval: No
• Idempotency key: Not needed

No inputs.

widget_update

Change the chat widget’s color, position, greeting, whether it shows above the launcher, and websites (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• color (required): A color like #1a73e8.
• position (required): bottom-right or bottom-left.
• greeting (required): The greeting customers see.
• showGreeting (required): true to show the greeting above the launcher. One of true, false.
• allowedDomains (required): Websites where the chat widget may appear.

workspace_rename

Rename the workspace (owner only).

• Who can run it: Owners
• Needs approval: No
• Idempotency key: Not needed

Inputs:

• name (required): The new name.