Connectors Reference

Microsoft Forms

Microsoft Forms is a new part of Office 365 Education that allows teachers and students to quickly and easily create custom quizzes, surveys, questionnaires, registrations and more.

 

Status: Preview

Tier: Standard

Version: 1.1.2

 

Actions:

Name

Summary

DeleteFormWebhook (string form_id, string webhookId)

 

GetFormResponseById (string form_id, integer response_id)

Get response details

ListForms ()

List forms

GetQuestions (string form_id)

Get questions

 

Triggers:

Name

Summary

CreateFormWebhook (string form_id, [Optional]WebhookRequestBody Request body of webhook)

When a new response is submitted

GetFormResponses (string form_id)

When a new response is submitted

 

Objects:

Name

Summary

GetFormResponseByIdResult

 

GetFormResponsesResponseItem

 

ListFormsResponseItem

 

WebhookRequestBody

 

 

Actions:

DeleteFormWebhook

Summary:

Description: Delete a webhook

 

Syntax:

MicrosoftForms.DeleteFormWebhook (string form_id, string webhookId)

 

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form title)

Pick a form.

True

webhookId

string

 

ID of the webhook being deleted

True

 

Returns:

 

GetFormResponseById

Summary: Get response details

Description: This action retrieves a form response

 

Syntax:

MicrosoftForms.GetFormResponseById (string form_id, integer response_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form Id)

Unique identifier of the form

True

ListForms

response_id

integer(int32)

(Response Id)

Unique identifier of the response

True

 

Returns:

          Type:GetFormResponseByIdResult

          Description: Form response details

 

ListForms

Summary: List forms

Description: This operation returns a list of forms in your account.

 

Syntax:

MicrosoftForms.ListForms ()

 

Returns:

          Type:array of (ListFormsResponseItem)

 

GetQuestions

Summary: Get questions

Description: Get questions definition in a form.

 

Syntax:

MicrosoftForms.GetQuestions (string form_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form Id)

Unique id of the form.

True

ListForms

 

Returns:

          Type:string

 

Triggers:

Trigger CreateFormWebhook

Summary: When a new response is submitted

Description: This operation triggers a flow when a new response is submitted.

 

Syntax:

MicrosoftForms.CreateFormWebhook (string form_id, [Optional]WebhookRequestBody Request body of webhook)

 

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form Id)

Pick a form.

True

ListForms

Request body of webhook

WebhookRequestBody

 

 

False

 

Returns:

 

Trigger GetFormResponses

Summary: When a new response is submitted

Description: This operation triggers a flow when a new response is submitted.

 

Syntax:

MicrosoftForms.GetFormResponses (string form_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form title)

Pick a form.

True

ListForms

 

Returns:

          Type:array of (GetFormResponsesResponseItem)

          Description: Form responses

 


 

GetFormResponseByIdResult

Summary:

Description: Form response details

 

          Properties:

Name

Type

Summary


 

GetFormResponsesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ListFormsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Form Id

Unique id of the form.

title

string

Form title

Title of the form.


 

WebhookRequestBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

eventType

string

 

Webhook event

notificationUrl

string(uri)

 

Webhook callback url

source

string

 

Source of webhook registration