Connectors Reference
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.
|
Status: Preview |
Tier: Premium |
Version: v1 |
|
Name |
Summary |
|
Comment_Add (Comment_AddParameterCreateCommentCommand CreateCommentCommand) |
Add a comment to a checklist instance step |
|
Get All Checklist Instances |
|
|
Create Checklist Instance |
|
|
Get A Checklist Instance |
|
|
Get Checklist Instance Activity |
|
|
Find Checklist Step |
|
|
Get A Checklist Step |
|
|
Complete a Checklist Step |
|
|
Get Company |
|
|
Get Company Roles |
|
|
ProcedureAcceptances_GetAll ([advanced][Optional]integer limit, [advanced][Optional]integer offset) |
Get All Procedure Acceptances |
|
Find_Checklist ([Optional]string query, [internal]integer type) |
Find Checklist |
|
Get A Checklist |
|
|
Find_Checklist_Instances (integer procedureId, [Optional]string query) |
Find Checklist Instance |
|
Get Security Roles |
|
|
Get Time Zones |
|
|
Get User |
|
|
Find User |
|
|
Users_Post (Users_PostParameterCreate User Command Create User Command) |
Add a New User |
|
Name |
Summary |
|
When a checklist instance is started |
|
|
New_Comment_WebHook (New_Comment_WebHookParameterWebhook Registration Webhook Registration) |
When a comment is added to a checklist |
|
When a checklist is finished |
|
|
When a supervisor is invited |
|
|
When a procedure is accepted |
|
|
When a checklist step is completed |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Checklist_Step_Completed_WebHookParameterWebhook Registration |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Generate_Acceptance_PDF_WebHookParameterWebhook Registration |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Add a comment to a checklist instance step
Description: Adds a new comment to an Activated Checklist Instance step.
Syntax:
WayWeDo.Comment_Add (Comment_AddParameterCreateCommentCommand CreateCommentCommand)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
CreateCommentCommand |
Comment_AddParameterCreateCommentCommand
|
|
True |
Returns:
Type:ChecklistComment
Summary: Get All Checklist Instances
Description: Retrieves a list of all activated checklist instances.
Syntax:
WayWeDo.GetAll_ChecklistInstances ([advanced][Optional]integer limit, [advanced][Optional]integer offset, [advanced][Optional]integer status)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
limit |
integer(int32) (Limit) |
Maximum number of results to fetch. |
False |
|
|
offset |
integer(int32) (Offset) |
The number of records skipped. |
False |
|
|
status |
integer(int32) (Status) |
The status of instances returned. |
False |
Returns:
Type:GetAll_ChecklistInstancesResponse
Summary: Create Checklist Instance
Description: Creates a new activated checklist instance.
Syntax:
WayWeDo.ChecklistInstances_Post (ChecklistInstances_PostParameterCreateInstanceCommand CreateInstanceCommand)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
CreateInstanceCommand |
ChecklistInstances_PostParameterCreateInstanceCommand
|
|
True |
Returns:
Type:ChecklistInstance
Summary: Get A Checklist Instance
Description: Retrieves a specific activated checklist instance
Syntax:
WayWeDo.ChecklistInstances_Get (string instanceId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
instanceId |
string(guid) (Instance ID) |
Select the checklist instance |
True |
Returns:
Type:ChecklistInstance
Summary: Get Checklist Instance Activity
Description: Retrieve all activity for a checklist instance
Syntax:
WayWeDo.ChecklistInstances_Activity (string instanceId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
instanceId |
string(guid) (Instance Id) |
Select the checklist instance |
True |
Returns:
Type:array of (ChecklistInstances_ActivityResponseItem)
Summary: Find Checklist Step
Description: Find a step of a checklist instance
Syntax:
WayWeDo.Find_Steps (string instanceId, [Optional]string query)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
instanceId |
string(guid) (Instance Id) |
Select the checklist instance |
True |
|
|
query |
string (Step Title) |
Search for a step title |
False |
Returns:
Type:array of (ChecklistStep)
Summary: Get A Checklist Step
Description: Retrieves a specific checklist step
Syntax:
WayWeDo.ChecklistSteps_Get (string instanceId, string stepId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
instanceId |
string(guid) (Instance Id) |
Select the checklist instance |
True |
|
|
stepId |
string(guid) (Step Id) |
Select the checklist step |
True |
Returns:
Type:ChecklistStep
Summary: Complete a Checklist Step
Description: Mark a specific step in a checklist instance as complete.
Syntax:
WayWeDo.ChecklistSteps_Complete (string instanceId, string stepId, [Optional]ChecklistSteps_CompleteParameterComplete Step Command Complete Step Command)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
instanceId |
string(guid) (Instance Id) |
Select the checklist instance |
True |
|
|
stepId |
string(guid) (Step Id) |
Select the checklist step |
True |
|
|
Complete Step Command |
ChecklistSteps_CompleteParameterComplete Step Command
|
|
False |
Returns:
Type:ChecklistSteps_CompleteResponse
Summary: Get Company
Description: Retrieves your company ID and Name
Syntax:
WayWeDo.Company_GetCompany ()
Returns:
Type:Company_GetCompanyResponse
Summary: Get Company Roles
Description: Retrieve all the company roles.
Syntax:
WayWeDo.CompanyRoles_GetAll ()
Returns:
Type:array of (CompanyRoles_GetAllResponseItem)
Summary: Get All Procedure Acceptances
Description: Retrieves a list of all procedure acceptances.
Syntax:
WayWeDo.ProcedureAcceptances_GetAll ([advanced][Optional]integer limit, [advanced][Optional]integer offset)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
limit |
integer(int32) (Limit) |
Maximum number of results to fetch. |
False |
|
|
offset |
integer(int32) (Offset) |
The number of records skipped. |
False |
Returns:
Type:ProcedureAcceptances_GetAllResponse
Summary: Find Checklist
Description: Search for a checklist by title
Syntax:
WayWeDo.Find_Checklist ([Optional]string query, [internal]integer type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
query |
string (Checklist Title) |
The title of the checklist |
False |
|
|
type |
integer(int32) (Procedure Type) |
The type of procedure; either 1 (standard) or 2 (checklist). |
True |
Returns:
Type:array of (Procedure)
Summary: Get A Checklist
Description: Retrieves a specific checklist or procedure by ID.
Syntax:
WayWeDo.Procedures_Get (integer procedureId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
procedureId |
integer(int32) (Procedure ID) |
Select a checklist |
True |
Returns:
Type:Procedure
Summary: Find Checklist Instance
Description: Search for a checklist instance by title.
Syntax:
WayWeDo.Find_Checklist_Instances (integer procedureId, [Optional]string query)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
procedureId |
integer(int32) (Procedure ID) |
Select a checklist |
True |
|
|
query |
string (Instance Title) |
The title of the checklist instance. |
False |
Returns:
Type:array of (ChecklistInstance)
Summary: Get Security Roles
Description: Retrieve a list of all security roles
Syntax:
WayWeDo.SecurityRoles_IdTitle ()
Returns:
Type:array of (SecurityRoles_IdTitleResponseItem)
Summary: Get Time Zones
Description: Rectrieve a list of all time zones.
Syntax:
WayWeDo.TimeZones_Get ()
Returns:
Type:array of (TimeZones_GetResponseItem)
Summary: Get User
Description: Retrieves a specific user by ID
Syntax:
WayWeDo.Users_Get (integer userId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
userId |
integer(int32) (User ID) |
Select the user. |
True |
Returns:
Type:User
Summary: Find User
Description: Search for a user by name or email.
Syntax:
WayWeDo.Find_User ([Optional]string query)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
query |
string (Email Address Or Name) |
The name or email address of the user. |
False |
Returns:
Type:array of (User)
Summary: Add a New User
Description: Creates and invites a new user.
Syntax:
WayWeDo.Users_Post (Users_PostParameterCreate User Command Create User Command)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Create User Command |
Users_PostParameterCreate User Command
|
|
True |
Returns:
Type:Users_PostResponse
Summary: When a checklist instance is started
Description: This operation triggers when a checklist instance is started.
Syntax:
WayWeDo.Checklist_Create_WebHook (Checklist_Create_WebHookParameterWebhook Registration Webhook Registration)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Webhook Registration |
Checklist_Create_WebHookParameterWebhook Registration
|
|
True |
Returns:
Type:WebhookRegistered
Summary: When a comment is added to a checklist
Description: This operation triggers when a new comment is added to a checklist.
Syntax:
WayWeDo.New_Comment_WebHook (New_Comment_WebHookParameterWebhook Registration Webhook Registration)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Webhook Registration |
New_Comment_WebHookParameterWebhook Registration
|
|
True |
Returns:
Type:WebhookRegistered
Summary: When a checklist is finished
Description: This operation triggers when a checklist is finished.
Syntax:
WayWeDo.Finish_Checklist_WebHook (Finish_Checklist_WebHookParameterWebhook Registration Webhook Registration)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Webhook Registration |
Finish_Checklist_WebHookParameterWebhook Registration
|
|
True |
Returns:
Type:WebhookRegistered
Summary: When a supervisor is invited
Description: This operation triggers when a supervisor invite is generated.
Syntax:
WayWeDo.Invite_Supervisor_WebHook (Invite_Supervisor_WebHookParameterWebhook Registration Webhook Registration)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Webhook Registration |
Invite_Supervisor_WebHookParameterWebhook Registration
|
|
True |
Returns:
Type:WebhookRegistered
Summary: When a procedure is accepted
Description: This operation triggers when a procedure is accepted.
Syntax:
WayWeDo.Generate_Acceptance_PDF_WebHook (Generate_Acceptance_PDF_WebHookParameterWebhook Registration Webhook Registration)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Webhook Registration |
Generate_Acceptance_PDF_WebHookParameterWebhook Registration
|
|
True |
Returns:
Type:WebhookRegistered
Summary: When a checklist step is completed
Description: This operation triggers when a checklist step is completed.
Syntax:
WayWeDo.Checklist_Step_Completed_WebHook (Checklist_Step_Completed_WebHookParameterWebhook Registration Webhook Registration)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Webhook Registration |
Checklist_Step_Completed_WebHookParameterWebhook Registration
|
|
True |
Returns:
Type:WebhookRegistered
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Comment ID |
The unique ID of the comment. |
|
type |
integer Comment Type |
The type of comment; either 1 (standard) or 2 (attachment). Values: [, ] |
|
procedureId |
integer(int32) Procedure ID |
The unique ID of the procedure. |
|
procedureTitle |
string Procedure Title |
The title of the procedure. |
|
instanceId |
string Instance ID |
The unique ID of the checklist instance. |
|
stepId |
string Step ID |
The unique ID of the checklist step. |
|
instanceTitle |
string Instance Title |
The title of the checklist instance. |
|
comment |
string Comment Text |
The comment text added to the step. |
|
created |
string(date-time) Comment Date |
The date and time the comment was created. |
|
createdBy |
string Comment User |
The email address of the user who created the comment. |
|
imageUrl |
string Comment Attachment URL |
The URL to the attached file. Valid for 5 minutes. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Instance ID |
The unique ID of the checklist instance. |
|
procedureId |
integer(int32) Procedure ID |
The unique ID of the procedure. |
|
title |
string Instance Title |
The title of the checklist instance. |
|
url |
string Instance URL |
The URL to the checklist instance. |
|
created |
string(date-time) Instance Created Date |
The date and time the checklist instance was started. |
|
createdBy |
string Instance User |
The email address of the user who started the checklist instance. |
|
finished |
string(date-time) Instance Finish Date |
The date and time the checklist instance was finished. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
occurred |
string(date-time) Occurred |
The date and time the activity occurred. |
|
title |
string Description |
A description of the activity that occurred. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
procedureId |
integer(int32) Procedure ID |
Select a checklist master |
|
title |
string Title |
The title of the checklist instance |
|
userId |
integer(int32) User ID |
Select the user creating the instance |
|
bot |
string Bot Name |
The name of the bot creating the instance |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Step ID |
The unique ID of the instance step. |
|
title |
string Step Title |
The title of the instance step. |
|
ordinal |
integer(int32) Step Number |
The number of the instance step. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userId |
integer(int32) User ID |
Select the user completing the step |
|
bot |
string Bot Name |
The name of the bot that completed the checklist step |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackUrl |
string Callback URL |
The URL to call when action occurs. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackUrl |
string Callback URL |
The URL to call when action occurs. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
instanceId |
string Checklist Instance ID |
Select the checklist instance |
|
stepId |
string Step ID |
Select the step of the checklist instance |
|
userId |
integer(int32) User ID |
Select the user creating the comment |
|
message |
string Comment Text |
Specify the comment to add |
|
bot |
string Bot Name |
The name of the bot creating the comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Role ID |
The unique ID of the company role. |
|
title |
string(date-time) Role Title |
The name of the company role. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Company ID |
The unique ID of your company. |
|
title |
string Company Title |
The name of the company registered with Way We Do |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackUrl |
string Callback URL |
The URL to call when action occurs. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackUrl |
string Callback URL |
The URL to call when action occurs. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
results |
array of (ChecklistInstance) Checklist Instances |
The list of checklist instances. |
|
_total |
integer(int32) Total |
The total number of checklist instances. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackUrl |
string Callback URL |
The URL to call when action occurs. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
callbackUrl |
string Callback URL |
The URL to call when action occurs. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Procedure ID |
The unique ID of the procedure. |
|
title |
string Procedure Title |
The title of the procedure. |
|
status |
string Procedure Status |
The publishing status of the procedure. |
|
summary |
string Procedure Summary |
The summary of the procedure. |
|
createdBy |
string Created By |
The email of the user that created the procedure. |
|
url |
string Procedure URL |
The URL of the procedure. |
|
restricted |
boolean Restricted |
Wether the procedure is restricted or not. Values: [, ] |
|
type |
integer Procedure Type |
The type of procedure; 1 (standard) or 2 (checklist) Values: [, ] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Acceptance ID |
The unique ID of the procedure acceptance |
|
accepted |
string(date-time) Accepted |
The date and time the procedure was accepted. |
|
createdBy |
string Accepted By |
The email address of the user that accepted the procedure. |
|
fileName |
string PDF File Name |
The file name of the generated PDF. |
|
attachmentUrl |
string PDF URL |
The URL to the generated PDF. Valid for 5 minutes. |
|
procedureTitle |
string Procedure Title |
The title of the accepted procedure. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
results |
array of (ProcedureAcceptance) Procedure Acceptances |
The list of procedure acceptances. |
|
_total |
integer(int32) Total |
The total number of procedure acceptances. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Security Role ID |
The unique id of the security role. |
|
title |
string(date-time) Security Role Title |
The title of the security role. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Time Zone ID |
The unique ID of the time zone. |
|
title |
string Time Zone Title |
The title of the time zone. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) User ID |
The unique ID of the user. |
|
firstName |
string First Name |
The first name of the user. |
|
lastName |
string Last Name |
The last name of the user. |
|
|
string |
The email address of the user. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
firstName |
string First Name |
The first name of the user. |
|
lastName |
string Last Name |
The last name of the user. |
|
|
string |
The email address of the user. |
|
securityRole |
integer(int32) Security Role |
Select a security role. |
|
companyRoles |
array of (integer(int32))
|
|
|
timeZoneId |
string Time Zone |
Select the user's timezone. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Webhook ID |
The unique ID of the Webhook registration. |
|
callbackurl |
string Callback URL |
The URL to call when action occurs. |
|
created |
string(date-time) Created Date |
The date and time the webhook was registered. |
|
webHookEvent |
string Webhook Event |
The name of the webhook event. |