Totango

App · 17 actions

Work with your Totango customer success data: search accounts and their health, update account and user attributes, track usage, log and manage touchpoints and tasks, run SuccessPlays, and start workflows when accounts, health, touchpoints, tasks or alerts change.

Actions

ActionWhat it does
Create taskCreate a task on an account for someone on your team, filed under a flow, with a due date and priority.
Create touchpointLog a touchpoint (a call, meeting, email or note) on an account's timeline, with its flow, type and reasons.
Delete taskDelete a task from an account.
Delete touchpointRemove a touchpoint from its account's timeline.
List account timelineList what is on an account's timeline, newest first: touchpoints, tasks and alerts.
List flowsList the flows (activity types, such as Onboarding or Renewal) that touchpoints and tasks are filed under.
List touchpoint reasonsList the touchpoint reasons (tags), such as Renewal discussion.
List touchpoint typesList the touchpoint types, such as Meeting, Call or Email.
List touchpointsList an account's touchpoints, newest first, with their text, author, flow and the ids to update or delete them.
Run SuccessPlayRun a manual SuccessPlay on an account, which creates its tasks.
Search accountsFind accounts (your customers) with Totango's search filters, with their health and any attributes you name.
Search usersFind users (the people at your customers who use your product) with Totango's search filters, with any attributes you name.
Track activityRecord that a user did something in your product, such as Exported a report in Reports.
Update account attributesSet attributes on an account, such as its plan, renewal date or contract value.
Update taskChange a task's due date, priority, assignee or status, such as closing it.
Update touchpointRewrite a touchpoint's text and, if given, its subject, flow, type, reasons and participants.
Update user attributesSet attributes on a user in an account, such as their role.

Create task

Create a task on an account for someone on your team, filed under a flow, with a due date and priority.

Inputs

Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.
TitletitletextRequired
What to do.
Flowflow_idtextRequired
The flow (activity type) to file it under, such as Onboarding.
Descriptiondescriptiontext
More about the task.
Due datedue_datedate
When the task is due.
Priorityprioritytext
High, normal or low.One of: 1 (High), 2 (Normal), 3 (Low).
Assignee emailassigneetext
The email address of the Totango user to give it to.
Statusstatustext
Open or closed.One of: open, closed.

Outputs

account_idtext
The account
createdtrue/false
Whether it was created
messagetext
What Totango answered, such as Success
titletext
The task's title
Example output
{
  "account_id": "0012A00001xyzAB",
  "created": true,
  "message": "Success",
  "title": "Book the quarterly review"
}

Create touchpoint

Log a touchpoint (a call, meeting, email or note) on an account's timeline, with its flow, type and reasons. It is logged as the token's owner unless you name someone else.

Inputs

Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.
TextcontenttextRequired
What happened, up to 12,000 characters. Plain text only.
Subjectsubjecttext
A subject line.
Flowflow_idtext
The flow (activity type) to file it under, such as Onboarding.
Typetouchpoint_type_idtext
The touchpoint's type, such as Meeting, Call or Email.
Reasonstag_idslist
The touchpoint reasons (tags) to give it.
Participantsparticipant_idslist
The Totango user ids (usually email addresses) of who took part.
Logged bycreated_bytext
The email address of who to show as its author. Defaults to the token's owner.
Whenhappened_atdate and time
When it happened. Defaults to now.
Don't sync to your CRMdisable_synctrue/false
Keep this touchpoint out of Salesforce and other connected tools, such as when it came from there.

Outputs

account_idtext
The account
createdtrue/false
Whether it was created
note_idtext
The touchpoint's note id, when Totango's answer gives it; otherwise find it with 'List touchpoints'
responseobject
Totango's answer
Example output
{
  "account_id": "0012A00001xyzAB",
  "created": true,
  "note_id": "47124",
  "response": {
    "note_id": 47124
  }
}

Delete task

Delete a task from an account.

Inputs

Task IDtask_idtextRequired
The task's id, from the task's page in Totango or an earlier step.
Accountaccount_idtextRequired
The task's account.

Outputs

account_idtext
The task's account
deletedtrue/false
Always true once deleted
task_idtext
The task
Example output
{
  "account_id": "0012A00001xyzAB",
  "deleted": true,
  "task_id": "12345"
}

Delete touchpoint

Remove a touchpoint from its account's timeline.

Inputs

Note IDnote_idtextRequired
The touchpoint's note_id, from 'List touchpoints'.
Event IDevent_idtextRequired
The touchpoint's event_id, from 'List touchpoints'.

Outputs

deletedtrue/false
Always true once deleted
event_idtext
The touchpoint's event id
note_idtext
The touchpoint's note id
Example output
{
  "deleted": true,
  "event_id": "4a0c13edzfacez3038zbb46z85f97f04238f",
  "note_id": "47124"
}

List account timeline

List what is on an account's timeline, newest first: touchpoints, tasks and alerts.

Inputs

Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.
Showevent_typetext
Everything, or only touchpoints, tasks or alerts.One of: all (Everything (default)), note (Touchpoints), task (Tasks), alert (Alerts).

Outputs

countnumber
How many
eventslist
The events, newest first
Example output
{
  "count": 1,
  "events": [
    {
      "account": {
        "id": "0012A00001xyzAB"
      },
      "id": "4a0c13edzfacez3038zbb46z85f97f04238f",
      "note_content": {
        "note_id": 47124,
        "text": "Kick-off call went well.",
        "totango_user": {
          "user_name": "jo@example.com"
        }
      },
      "properties": {
        "activity_type_id": "onboarding",
        "meeting_type": "0af9272e-a055-441e-ae10-f4223a3e0ab8",
        "subject": "Kick-off",
        "touchpoint_tags": [
          "450ea17a-0e76-418f-a4ec-8ae7b16b3b85"
        ]
      },
      "timestamp": 1578588991000,
      "type": "note"
    }
  ]
}

List flows

List the flows (activity types, such as Onboarding or Renewal) that touchpoints and tasks are filed under.

Inputs

None.

Outputs

countnumber
How many
flowslist
The flows
Example output
{
  "count": 1,
  "flows": [
    {
      "default_type": false,
      "disabled": false,
      "id": "renewal",
      "name": "Renewal",
      "system_type": true
    }
  ]
}

List touchpoint reasons

List the touchpoint reasons (tags), such as Renewal discussion.

Inputs

None.

Outputs

countnumber
How many
touchpoint_tagslist
The reasons
Example output
{
  "count": 1,
  "touchpoint_tags": [
    {
      "id": "450ea17a-0e76-418f-a4ec-8ae7b16b3b85",
      "name": "Renewal discussion"
    }
  ]
}

List touchpoint types

List the touchpoint types, such as Meeting, Call or Email.

Inputs

None.

Outputs

countnumber
How many
touchpoint_typeslist
The types
Example output
{
  "count": 1,
  "touchpoint_types": [
    {
      "id": "0af9272e-a055-441e-ae10-f4223a3e0ab8",
      "name": "Meeting"
    }
  ]
}

List touchpoints

List an account's touchpoints, newest first, with their text, author, flow and the ids to update or delete them.

Inputs

Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.
Containingcontainstext
Only touchpoints whose subject or text contains these words.

Outputs

countnumber
How many
touchpointslist
The touchpoints, newest first
Example output
{
  "count": 1,
  "touchpoints": [
    {
      "account_id": "0012A00001xyzAB",
      "author": "jo@example.com",
      "event_id": "4a0c13edzfacez3038zbb46z85f97f04238f",
      "flow_id": "onboarding",
      "happened_at": "2020-01-09T16:56:31Z",
      "note_id": "47124",
      "subject": "Kick-off",
      "tag_ids": [
        "450ea17a-0e76-418f-a4ec-8ae7b16b3b85"
      ],
      "text": "Kick-off call went well.",
      "timestamp": 1578588991000,
      "touchpoint_type_id": "0af9272e-a055-441e-ae10-f4223a3e0ab8"
    }
  ]
}

Run SuccessPlay

Run a manual SuccessPlay on an account, which creates its tasks. The SuccessPlay must be manual and active.

Inputs

SuccessPlay IDsuccessplay_idtextRequired
The SuccessPlay's id, from the address of its page in Totango's SuccessPlays tab.
Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.

Outputs

account_idtext
The account
messagetext
What Totango answered
startedtrue/false
Whether Totango started it
successplay_idtext
The SuccessPlay
Example output
{
  "account_id": "0012A00001xyzAB",
  "message": "Success",
  "started": true,
  "successplay_id": "a08873d9-55bc-494d-bf79-6d88078913fc"
}

Search accounts

Find accounts (your customers) with Totango's search filters, with their health and any attributes you name. Gets one page of up to 1,000; to see more, run it again with the next offset.

Inputs

Filtersfilterslist
Which to include, as Totango search terms. Build the search in Totango, open its menu, choose Generate API endpoint and copy the terms list. Leave blank for all.
Attributes to returnattributeslist
Names of account attributes to include, exactly as Totango shows them, such as Success Manager or Contract Value.
Include healthinclude_healthtrue/false
Also return each account's health (good, average or poor).
Sort bysort_bytext
The field to sort by, such as display_name (the default) or an attribute's name.
Ordersort_ordertext
Ascending (the default) or descending.One of: ASC (A to Z, lowest first (default)), DESC (Z to A, highest first).
How manycountnumber
How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get the next page: use next_offset from the page before.At least 0.

Outputs

accountslist
The accounts
countnumber
How many are on this page
next_offsetnumber
The Skip value for the next page, or 0 at the end
total_hitsnumber
How many match in all
Example output
{
  "accounts": [
    {
      "account_id": "0012A00001xyzAB",
      "display_name": "Acme Inc",
      "fields": {
        "Health": "good",
        "Success Manager": "jo@example.com"
      },
      "last_activity_time": 1731830400000,
      "selected_fields": [
        "good",
        "jo@example.com"
      ]
    }
  ],
  "count": 1,
  "next_offset": 0,
  "total_hits": 1
}

Search users

Find users (the people at your customers who use your product) with Totango's search filters, with any attributes you name. Gets one page of up to 1,000.

Inputs

Filtersfilterslist
Which to include, as Totango search terms. Build the search in Totango, open its menu, choose Generate API endpoint and copy the terms list. Leave blank for all.
Attributes to returnattributeslist
Names of user attributes to include, exactly as Totango shows them, such as Success Manager or Contract Value.
Sort bysort_bytext
The field to sort by, such as display_name (the default) or an attribute's name.
Ordersort_ordertext
Ascending (the default) or descending.One of: ASC (A to Z, lowest first (default)), DESC (Z to A, highest first).
How manycountnumber
How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.
Skipoffsetnumber
How many to skip, to get the next page: use next_offset from the page before.At least 0.

Outputs

countnumber
How many are on this page
next_offsetnumber
The Skip value for the next page, or 0 at the end
total_hitsnumber
How many match in all
userslist
The users
Example output
{
  "count": 1,
  "next_offset": 0,
  "total_hits": 1,
  "users": [
    {
      "display_name": "Sam Lee",
      "fields": {
        "Role": "Admin"
      },
      "last_activity_time": 1731830400000,
      "selected_fields": [
        "Admin"
      ],
      "user_id": "sam@acme.example"
    }
  ]
}

Track activity

Record that a user did something in your product, such as Exported a report in Reports. Totango counts it toward usage and health. Needs the Service ID on the connection.

Inputs

Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.
User IDend_user_idtextRequired
The user's id in your product, usually their email address. Totango adds the user if it is new.
ActivityactivitytextRequired
What they did, such as Exported a report.
ModulemoduletextRequired
Where in your product they did it, such as Reports.

Outputs

account_idtext
The account
activitytext
The activity
moduletext
The module
senttrue/false
Whether Totango took the activity
user_idtext
The user
Example output
{
  "account_id": "0012A00001xyzAB",
  "activity": "Exported a report",
  "module": "Reports",
  "sent": true,
  "user_id": "sam@acme.example"
}

Update account attributes

Set attributes on an account, such as its plan, renewal date or contract value. An account Totango doesn't have yet is added. Needs the Service ID on the connection.

Inputs

Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.
AttributesattributesobjectRequired
Attribute names and the values to set, such as Plan: Enterprise. A name Totango doesn't have yet is added.
Account nameaccount_nametext
The name to show for the account.
Parent accountparent_account_idtext
For an account in a hierarchy, the account it belongs under.

Outputs

account_idtext
The account
attributesobject
The attributes sent
senttrue/false
Whether Totango took the attributes
Example output
{
  "account_id": "0012A00001xyzAB",
  "attributes": {
    "Plan": "Enterprise"
  },
  "sent": true
}

Update task

Change a task's due date, priority, assignee or status, such as closing it.

Inputs

Task IDtask_idtextRequired
The task's id, from the task's page in Totango or an earlier step.
Accountaccount_idtext
The task's account.
Due datedue_datedate
When the task is due.
Priorityprioritytext
High, normal or low.One of: 1 (High), 2 (Normal), 3 (Low).
Assignee emailassigneetext
The email address of the Totango user to give it to.
Statusstatustext
Open or closed.One of: open, closed.

Outputs

messagetext
What Totango answered, such as Success
task_idtext
The task
updatedtrue/false
Whether it was updated
Example output
{
  "message": "Success",
  "task_id": "12345",
  "updated": true
}

Update touchpoint

Rewrite a touchpoint's text and, if given, its subject, flow, type, reasons and participants.

Inputs

Note IDnote_idtextRequired
The touchpoint's note_id, from 'List touchpoints'.
Event IDevent_idtextRequired
The touchpoint's event_id, from 'List touchpoints'.
Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.
TextcontenttextRequired
What happened, up to 12,000 characters. Plain text only.
Subjectsubjecttext
A subject line.
Flowflow_idtext
The flow (activity type) to file it under, such as Onboarding.
Typetouchpoint_type_idtext
The touchpoint's type, such as Meeting, Call or Email.
Reasonstag_idslist
The touchpoint reasons (tags) to give it.
Participantsparticipant_idslist
The Totango user ids (usually email addresses) of who took part.
Don't sync to your CRMdisable_synctrue/false
Keep this touchpoint out of Salesforce and other connected tools, such as when it came from there.

Outputs

event_idtext
The touchpoint's event id
note_idtext
The touchpoint's note id
responseobject
Totango's answer
updatedtrue/false
Whether it was updated
Example output
{
  "event_id": "4a0c13edzfacez3038zbb46z85f97f04238f",
  "note_id": "47124",
  "response": {},
  "updated": true
}

Update user attributes

Set attributes on a user in an account, such as their role. A user Totango doesn't have yet is added. Needs the Service ID on the connection.

Inputs

Accountaccount_idtextRequired
The account. Pick one, or give its Totango account id from an earlier step.
User IDend_user_idtextRequired
The user's id in your product, usually their email address. Totango adds the user if it is new.
AttributesattributesobjectRequired
Attribute names and the values to set, such as Plan: Enterprise. A name Totango doesn't have yet is added.
User nameuser_nametext
The name to show for the user.

Outputs

account_idtext
The account
attributesobject
The attributes sent
senttrue/false
Whether Totango took the attributes
user_idtext
The user
Example output
{
  "account_id": "0012A00001xyzAB",
  "attributes": {
    "Role": "Admin"
  },
  "sent": true,
  "user_id": "sam@acme.example"
}

On this page