Incoming Webhooks (Actions/PUSH)

10 min

Jun 19, 2023

Create Project

Creates a Project in Webvizio

HTTP request method – POST

Request sample

Fields

Name	Type	Description
url (required)	string	Project URL
externalId	string	Project external id
name	string	Project name
screenshot	string	Project screenshot

Update Project

Updates a Project in Webvizio.

HTTP request method – POST

Request sample

Fields

Name	Type	Description
id	integer	Project id
externalId	string	Project external id
uuid	string	Project universally unique identifier
name	string	Project name
screenshot	string	Project screenshot

*id | externalId | uuid – required

Delete Project

Deletes a Project from Webvizio

HTTP request method – DELETE

Request sample

Fields

Name	Type	Description
id	integer	Project id
externalId	string	Project external id
uuid	string	Project universally unique identifier

*id | externalId | uuid – required

Create/Update/Delete Project response sample

Fields

Name	Type	Description
id	integer	Project Id
uuid	string	Project universally unique identifier
externalId	string\|null	Project external id
name	string	Project name
screenshot	string\|null	Project Screenshot
url	string\|null	Project Url
createdAt	string	Comment creation date in iso8601 format
updatedAt	string	Date the project was last updated in iso8601 format

Find Project

Finds a Project in Webvizio

HTTP request method – POST

Request sample

Fields

Name	Type	Description
id	integer	Project id
externalId	string	Project external id
uuid	string	Project universally unique identifier
name	string	Project name

*id | externalId | uuid | name – required

Response sample

Fields

Name	Type	Description
id	integer	Project Id
uuid	string	Project universally unique identifier
externalId	string\|null	Project external id
Name	string	Project name
screenshot	string\|null	Project Screenshot
url	string\|null	Project Url
createdAt	string	Comment creation date in iso8601 format
updatedAt	string	Date the project was last updated in iso8601 format

Create Task

Creates a Task in Webvizio

HTTP request method – POST

Request sample

Fields

Name	Type	Description

externalId	string\|null	Task External Id
projectId	integer	Project Id
projectUuid	string	Project universally unique identifier
projectExternalId	string\|null	Project External Id
author	string	Task author email
name (required)	string	Task name
description	string	Task description (HTML format)
status	string	Task status. Can be one of the following values: Open, In progress, Done, Closed
priority	string	Task priority. Can be one of the following values: Low, Normal, High
executeAt	string	Task execute date in iso8601 format
tags	array	Task tags array
files	array	An array of task files, each element has two fields fileName, fileUrl
files.fileName	string	Task file name
files.fileUrl	string	Task file URL
assignees	array	Array of task assignees emails
timeLogs	array	An array of task time logs, each element has fields: ID, user, date, and time.
timeLogs.id	integer	Time log ID. If the ID is not specified a new time log will be created, if the ID is specified the current one will be updated.
timeLogs.user	string	Email of the time log author
timeLogs.date	string	Time log date in ISO8601 format
timeLogs.time	integer	Time log time in minutes

*projectId | projectUuid | projectExternalId – required

Update Task

Updates a Task in Webvizio

HTTP request method – POST

Request sample

Fields

Name	Type	Description
id	integer	Task id
externalId	string\|null	Task external id
name	string	Task name
description	string	Task description (html format)
status	string	Task status. Can be one of the following values: Open, In progress, Done, Closed
priority	string	Task priority. Can be one of the following values: Low, Normal, High
executeAt	string	Task execute date in iso8601 format
tags	array	Task tags array
files	array	An array of task files, each element has two fields fileName, fileUrl
files.fileName	string	Task file name
files.fileUrl	string	Task file url
assignees	array	Array of task assignees emails
timeLogs	array	An array of task time logs, each element has fields: ID, user, date, and time.
timeLogs.id	integer	Time log ID. If the ID is not specified a new time log will be created, if the ID is specified the current one will be updated.
timeLogs.user	string	Email of the time log author
timeLogs.date	string	Time log date in ISO8601 format
timeLogs.time	integer	Time log time in minutes

*id | externalId – required

Delete Task

Deletes a Task from Webvizio

HTTP request method – DELETE

Request sample

Fields

Name	Type	Description
id	integer	Task id
externalId	string\|null	Task external id

*id | externalId – required

Create/Update/Delete Task response sample

Fields

Name	Type	Description
id	integer	Task Id
externalId	string\|null	Task External Id
number	integer	Task number
projectId	integer	Project Id
projectUuid	string	Project universally unique identifier
projectExternalId	string\|null	Project External Id
author	string	Task author email
name	string	Task name
description	string	Task description
descriptionHtml	string\|null	Task description in HTML format
screenshot	string\|null	Task screenshot
status	string	Task status. Can be one of the following values: Open, In progress, Done, Closed
priority	string	Task priority. Can be one of the following values: Low, Normal, High
deviceType	string	Device type that was selected when creating the task. Can be one of the following values: fullScreen, responsive, desktop, tablet, mobile
createdAt	string	Task creation date in iso8601 format
updatedAt	string	Date the task was last updated in iso8601 format
os	string	Operating system used when creating the task
browser	string	Browser used when creating the task
executeAt	string	Task execute date in iso8601 format
tags	array	Task tags array
files	array	An array of task files, each element has two fields fileName, fileUrl
files.fileName	string	Task file name
files.fileUrl	string	Task file URL
videos	array	Array of videos URLs
assignees	array	Array of task assignees emails
timeLogs	array	An array of task time logs, each element has fields: ID, user, date, and time.
timeLogs.id	integer	Time log ID. If the ID is not specified a new time log will be created, if the ID is specified the current one will be updated.
timeLogs.user	string	Email of the time log author
timeLogs.date	string	Time log date in ISO8601 format
timeLogs.time	integer	Time log time in minutes

Find Task

Finds a Task in Webvizio

HTTP request method – POST

Request sample

Fields

Name	Type	Description
id	integer	Task id
externalId	string\|null	Task external id

*id | externalId – required

Response sample

Fields

Name	Type	Description
id	integer	Task Id
externalId	string\|null	Task External Id
number	integer	Task number
projectId	integer	Project Id
projectUuid	string	Project universally unique identifier
projectExternalId	string\|null	Project External Id
author	string	Task author email
name	string	Task name
description	string	Task description
descriptionHtml	string\|null	Task description in HTML format
screenshot	string\|null	Task screenshot
status	string	Task status. Can be one of the following values: Open, In progress, Done, Closed
priority	string	Task priority. Can be one of the following values: Low, Normal, High
deviceType	string	Device type that was selected when creating the task. Can be one of the following values: fullScreen, responsive, desktop, tablet, mobile
createdAt	string	Task creation date in iso8601 format
updatedAt	string	Date the task was last updated in iso8601 format
os	string	Operating system used when creating the task
browser	string	Browser used when creating the task
executeAt	string	Task execute date in iso8601 format
tags	array	Task tags array
files	array	An array of task files, each element has two fields fileName, fileUrl
files.fileName	string	Task file name
files.fileUrl	string	Task file URL
videos	array	Array of videos URLs
assignees	array	Array of task assignees emails
timeLogs	array	An array of task time logs, each element has fields: ID, user, date, and time.
timeLogs.id	integer	Time log ID. If the ID is not specified a new time log will be created, if the ID is specified the current one will be updated.
timeLogs.user	string	Email of the time log author
timeLogs.date	string	Time log date in ISO8601 format
timeLogs.time	integer	Time log time in minutes

Create Comment

Creates a Comment for the task

HTTP request method – POST

Request sample

Fields

Name	Type	Description
externalId	string\|null	Comment external id
taskId	integer	Task Id
taskExternalId	string\|null	Task external id
author	string	Comment author email
body	string	Comment body (html format)

*taskId | taskExternalId – required

Delete Comment

Deletes a Comment from Webvizio

HTTP request method – DELETE

Request sample

Fields

Name	Type	Description
id	integer	Comment id
externalId	string\|null	Comment external id

*id | externalId – required

Create/Delete Comment response sample

Fields

Name	Type	Description
id	integer	Comment Id
externalId	string\|null	Comment external id
taskId	integer	Task Id
taskExternalId	string\|null	Task external id
author	string	Comment author email
body	string	Comment body
bodyHtml	string\|null	Comment body in html format
createdAt	string	Comment creation date in iso8601 format

Find Comment

Finds a Comment in Webvizio

HTTP request method – POST

Request sample

Fields

Name	Type	Description
id	integer	Comment id
externalId	string\|null	Comment external id

*id | externalId – required

Response sample

Fields

Name	Type	Description
id	integer	Comment Id
externalId	string\|null	Comment external id
taskId	integer	Task Id
taskExternalId	string\|null	Task external id
author	string	Comment author email
body	string	Comment body (HTML format)
bodyHtml	string\|null	Comment body in HTML format
createdAt	string	Comment creation date in iso8601 format

Was this helpful?

What is next

REST Hooks

All Categories

Webhooks

Incoming Webhooks (Actions/PUSH)

Create Project

Request sample

Fields

Update Project

Request sample

Fields

Delete Project

Request sample

Fields

Create/Update/Delete Project response sample

Fields

Find Project

Request sample

Fields

Response sample

Fields

Create Task

Request sample

Fields

Update Task

Request sample

Fields

Delete Task

Request sample

Fields

Create/Update/Delete Task response sample

Fields

Find Task

Request sample

Fields

Response sample

Fields

Create Comment

Request sample

Fields

Delete Comment

Request sample

Fields

Create/Delete Comment response sample

Fields

Find Comment

Request sample

Fields

Response sample

Fields

Was this helpful?

Share

What is next