Action: Create User Invitation

Toggl Track Operation

The Create User Invitation action generates and sends an invitation link to add a new user to the workspace.

Example User Story

I want to invite a new user to my Toggl Track workspace so that they can start tracking time.

Fields

Field Name	Field Type	Required
email	String	Yes
workspaceId	Integer	Yes
admin	Boolean	No

Related Connections

Toggl Track

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "create-user-invitation",
  "state": "inDev",
  "meta": {
    "short": "Create User Invitation",
    "description": "Creates a user invitation in Toggl Track."
  },
  "input": [
    {
      "name": "email",
      "type": "String",
      "required": true,
      "meta": {
        "description": "Email address of the user to invite."
      }
    },
    {
      "name": "workspaceId",
      "type": "Integer",
      "required": true,
      "meta": {
        "description": "ID of the workspace to invite the user to."
      }
    },
    {
      "name": "admin",
      "type": "Boolean",
      "required": false,
      "meta": {
        "description": "Whether the invited user should have admin privileges."
      }
    }
  ],
  "output": [
    {
      "name": "invitationId",
      "type": "Integer",
      "selector": ["id"],
      "meta": {
        "description": "ID of the created invitation."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/workspaces/{{workspaceId}}/invitations",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\"email\":\"{{email}}\",\"admin\":{{admin}}}",
          "placeholders": [
            {
              "name": "email",
              "type": "String",
              "description": "Email address of the user to invite.",
              "required": true
            },
            {
              "name": "workspaceId",
              "type": "Integer",
              "description": "ID of the workspace to invite the user to.",
              "required": true
            },
            {
              "name": "admin",
              "type": "Boolean",
              "description": "Whether the invited user should have admin privileges.",
              "required": false,
              "default": "false"
            }
          ]
        }
      }
    }
  ]
}