Way We Do Integration API (Preview)

Way We Do enables teams to actively use repeatable policies, procedures, processes and playbooks in their day to day workflows to increase efficiency, quality and compliance.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
Contact
Name Way We Do
URL https://support.waywedo.com
Email support@waywedo.com

Creating a connection

To connect your account, you will need the following information:

Name Type Description
API Key securestring

The API Key for this api

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add a comment to a checklist instance step

Adds a new comment to an Activated Checklist Instance step.

Add a New User

Creates and invites a new user.

Complete a Checklist Step

Mark a specific step in a checklist instance as complete.

Create Checklist Instance

Creates a new activated checklist instance.

Find Checklist

Search for a checklist by title

Find Checklist Instance

Search for a checklist instance by title.

Find Checklist Step

Find a step of a checklist instance

Find User

Search for a user by name or email.

Get Checklist Instance Activity

Retrieve all activity for a checklist instance

Add a comment to a checklist instance step

Adds a new comment to an Activated Checklist Instance step.

Parameters

Name Key Required Type Description
Checklist Instance ID
instanceId True string

Select the checklist instance

Comment Text
message True string

Specify the comment to add

Step ID
stepId True string

Select the step of the checklist instance

User ID
userId True integer

Select the user creating the comment

Returns

Add a New User

Creates and invites a new user.

Parameters

Name Key Required Type Description
Company Roles
companyRoles integer

Select the company roles.

Email
email True string

The email address of the user.

First Name
firstName True string

The first name of the user.

Last Name
lastName True string

The last name of the user.

Security Role
securityRole True integer

Select a security role.

Time Zone
timeZoneId True string

Select the user's timezone.

Complete a Checklist Step

Mark a specific step in a checklist instance as complete.

Parameters

Name Key Required Type Description
Instance Id
instanceId True guid

Select the checklist instance

Step Id
stepId True guid

Select the checklist step

User ID
userId True integer

Select the user completing the step

Create Checklist Instance

Creates a new activated checklist instance.

Parameters

Name Key Required Type Description
Procedure ID
procedureId True integer

Select a checklist master

Title
title True string

The title of the checklist instance

User ID
userId True integer

Select the user creating the instance

Returns

Find Checklist

Search for a checklist by title

Parameters

Name Key Required Type Description
Checklist Title
query string

The title of the checklist

Returns

Find Checklist Instance

Search for a checklist instance by title.

Parameters

Name Key Required Type Description
Procedure ID
procedureId True integer

Select a checklist

Instance Title
query string

The title of the checklist instance.

Returns

Find Checklist Step

Find a step of a checklist instance

Parameters

Name Key Required Type Description
Instance Id
instanceId True guid

Select the checklist instance

Step Title
query string

Search for a step title

Returns

Find User

Search for a user by name or email.

Parameters

Name Key Required Type Description
Email Address Or Name
query string

The name or email address of the user.

Returns

response
array of User

Get Checklist Instance Activity

Retrieve all activity for a checklist instance

Parameters

Name Key Required Type Description
Instance Id
instanceId True guid

Select the checklist instance

Returns

Name Path Type Description
array of object
Occurred
occurred date-time

The date and time the activity occurred.

Description
title string

A description of the activity that occurred.

Triggers

When a checklist instance is started

This operation triggers when a checklist instance is started.

When a checklist is finished

This operation triggers when a checklst is finished.

When a comment is added to a checklist

This operation triggers when a new comment is added to a checklist.

When a procedure is accepted

This operation triggers when a procedure is accepted.

When a supervisor is invited

This operation triggers when a supervisor invite is generated.

When a checklist instance is started

This operation triggers when a checklist instance is started.

Returns

When a checklist is finished

This operation triggers when a checklst is finished.

Returns

Name Path Type Description
Instance Created Date
created date-time

The date and time the checklist instance was started.

Finshed By
createdBy string

The email address of the user that finished the checklist instance.

Instance Finish Date
finished date-time

The date and time the checklist instance was finished.

Instance ID
id string

The unique ID of the checklist instance.

Procedure ID
procedureId integer

The unique ID of the procedure.

Instance Title
title string

The title of the checklist instance.

Instance URL
url string

The URL to the checklist instance.

When a comment is added to a checklist

This operation triggers when a new comment is added to a checklist.

Returns

When a procedure is accepted

This operation triggers when a procedure is accepted.

Returns

When a supervisor is invited

This operation triggers when a supervisor invite is generated.

Returns

Name Path Type Description
collaborator
collaborator string

The email address of the supervisor

created
created date-time

The date and time the invite was created.

createdBy
createdBy string

The email address of the user that invited the supervisor.

instanceTitle
instanceTitle string

The title of the checklist instance.

Definitions

ChecklistComment

Name Path Type Description
Comment Text
comment string

The comment text added to the step.

Comment Date
created date-time

The date and time the comment was created.

Comment User
createdBy string

The email address of the user who created the comment.

Comment ID
id string

The unique ID of the comment.

Comment Attachment URL
imageUrl string

The URL to the attached file. Valid for 5 minutes.

Instance ID
instanceId string

The unique ID of the checklist instance.

Instance Title
instanceTitle string

The title of the checklist instance.

Procedure ID
procedureId integer

The unique ID of the procedure.

Procedure Title
procedureTitle string

The title of the procedure.

Step ID
stepId string

The unique ID of the checklist step.

Comment Type
type integer

The type of comment; either 1 (standard) or 2 (attachment).

ChecklistInstance

Name Path Type Description
Instance Created Date
created date-time

The date and time the checklist instance was started.

Instance User
createdBy string

The email address of the user who started the checklist instance.

Instance ID
id string

The unique ID of the checklist instance.

Procedure ID
procedureId integer

The unique ID of the procedure.

Instance Title
title string

The title of the checklist instance.

Instance URL
url string

The URL to the checklist instance.

ChecklistStep

Name Path Type Description
Step ID
id string

The unique ID of the instance step.

Step Number
ordinal integer

The number of the instance step.

Step Title
title string

The title of the instance step.

Procedure

Name Path Type Description
Created By
createdBy string

The email of the user that created the procedure.

Procedure ID
id integer

The unique ID of the procedure.

Restricted
restricted boolean

Wether the procedure is restricted or not.

Procedure Status
status string

The publishing status of the procedure.

Procedure Summary
summary string

The summary of the procedure.

Procedure Title
title string

The title of the procedure.

Procedure Type
type integer

The type of procedure; 1 (standard) or 2 (checklist)

Procedure URL
url string

The URL of the procedure.

ProcedureAcceptance

Name Path Type Description
Accepted
accepted date-time

The date and time the procedure was accepted.

PDF URL
attachmentUrl string

The URL to the generated PDF. Valid for 5 minutes.

Accepted By
createdBy string

The email address of the user that accepted the procedure.

PDF File Name
fileName string

The file name of the generated PDF.

Acceptance ID
id integer

The unique ID of the procedure acceptance

Procedure Title
procedureTitle string

The title of the accepted procedure.

User

Name Path Type Description
Email
email string

The email address of the user.

First Name
firstName string

The first name of the user.

User ID
id integer

The unique ID of the user.

Last Name
lastName string

The last name of the user.