API - Adding Users

EndPoint

https://wiggledesk.com/api/create_membership_invitation/

Overview

Our create_membership_invitation endpoint automates the invitations of new users to WiggleDesk.

If you have thousands of users it can incrementally add more overhead to your onboarding teams when getting them set up with internal services. WiggleDesk saves time by automating the provision of access to your spaces.

Behaviour

The API endpoint listens for POST requests containing an email addresses of users that you'd like to invite.

Shortly after (usually a few seconds), an email will be sent to the email provided, with an invitation to join your organisation's WiggleDesk account.

The invited user can then finalise their account settup either by creating a username/password or clicking 'sign on with Microsoft / Google'.

This is equivilent to inviting a user via our 'Manage Users' page:

Before We Begin

First grab your API key from your profile page. If you don't see it, you'll need to double check with a WiggleDesk Admin that your account has been given access and that the steps outlined in our 'Getting started' page have been followed.

WiggleDesk's API can be tested with httpie which is a basic http client written in Python.

You can install httpie using pip:

pip install httpie

Access API Via Code

The below example uses HTTPIE to illustrate how to connect to this endpoint. Simply swap out 'YOUR_SECRET_TOKEN' with your secret token and 'EXAMPLE@EXAMPLE.COM' with the email address of the user that you'd like to invite.

http POST https://wiggledesk.com/api/create_membership_invitation/ "Authorization: token YOUR_SECRET_TOKEN" email_invited=EXAMPLE@EXAMPLE.COM

Response

A successful response will return something like this:

HTTP/1.1 201 Created

Allow: POST, HEAD, OPTIONS

Content-Length: 119

Content-Type: application/json

Date: Tue, 14 Jun 2022 09:24:17 GMT

Location: https://wiggledesk.com/api/create_membership_invitation/membership_id/

Referrer-Policy: same-origin

Server: Google Frontend

Vary: Accept

X-Cloud-Trace-Context:

X-Content-Type-Options: nosniff

X-Frame-Options: SAMEORIGIN

{

"email_invited": "example@example.com",

"url": "https://wiggledesk.com/api/create_membership_invitation/membership_id/"

}

Access API Via Zapier

Coming Soon: Example of how we can listen to new users being added to a Teams directory and automatically inviting them to WiggleDesk.

Published June 18, 2022