Project webhook

This webhook is sending data to the defined API endpoints at creation and when any section of the project is updated.

As project data contain personal data, be sure to respect processing and storage regulations like GDPR (General Data Protection Regulation), CCPA (California Consumer Privacy Act), or any other applicable ones where you export such data.

Attributes

apiKey string
Added to the data if defined
id string
Unique identifier of the project.
title string
Title of the project.
url string
URL of the project.
createdAt date
Creation date and time of the project to iso format.
updatedAt date
Date and time of last update of the project to iso format.
author object
Author of the project.
author attributes
author.email string
Email address of the project author.
author.username string
Username name of the project author.
author.firstName string
First name of the project author.
author.lastName string
Last name of the project author.
author.role string
Role label of the project author.
participants array of object
Members of the project.
participant attributes
participant.email string
Email address of the project participant.
participant.username string
Username name of the project participant.
participant.firstName string
First name of the project participant.
participant.lastName string
Last name of the project participant.
participant.role string
Role label of the project participant.
challenges object
Challenges of the project.
participant attributes
participant.email string
Email address of the project participant.
banner string
Files URL of the project banner.
description string
Description of the project.
socialLinks object
Social media links of the project.
socialLinks attributes
socialLinks.facebook string
Facebook link of the project.
socialLinks.linkedin string
LinkedIn link of the project.
socialLinks.twitter string
Twitter link of the project.
socialLinks.youtube string
Youtube link of the project.
links array
List of URLs attached to the project.
issue object
The issue the project is responding to.
issue attributes
issue.raw string
Raw HTML content of the section.
issue.plainText string
The sanitized version of the section content.
issue.files array of string
List of files URL attached to the section.
solution object
The solution provided by the project.
solution attributes
solution.raw string
Raw HTML content of the section.
solution.plainText string
The sanitized version of the section content.
solution.files array of string
List of files URL attached to the section.
steps array of object
The steps necessary to implement the solution.
step attributes
step.title string
Title of the step.
step.image string
URL of the image representing the step.
step.content string
Description of the step.
freeSections array of object
Section that project members can format as they want.
freeSection attributes
freeSection.raw string
Raw HTML content of the section.
freeSection.plainText string
The sanitized version of the section content.
presentation object
Presentation file of the project.
presentation attributes
presentation.title string
Title of the presentation file.
presentation.file string
URL of the presentation file.
media array of string
List of image URLs.
customQuestions object
Answers to the custom questions of the project.
customQuestions attributes
customQuestions.['question.id'] multi-type

Content of the answer.

Depending on the type of question, this can be of type object or array of string

votes object
Vote results of the project.
votes attributes
votes.nbAllIn number
Number of votes for the first option.
votes.nbPivot number
Number of votes for the second option.
votes.nbKill number
Number of votes for the third option.
comments number
Number of comments of the project.

Sample data sent by the webhook (JSON) 

{
  "apiKey": "{API_KEY}"
  "id": "6246c1bfe02d2c7d418c96e3",
  "title": "My super project",
  "url": "https://sample-domain.com/#/project/6246c1bfe02d2c7d418c96e3",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T12:00:00.000Z",
  "published": "Published",
  "author": {
    "email": "john.doe@domain.com",
    "username": "johndoe",
    "firstName": "John",
    "lastName": "Doe",
    "role": "Attendee"
  },
  "participants": [
    {
      "email": "john.doe@domain.com",
      "username": "johndoe",
      "firstName": "John",
      "lastName": "Doe",
      "role": "Attendee"
    }
  ]
  "challenges": {
    "Theme #1": ["Challenge"],
    "Theme #2": ["Challenge"],
  },
  "banner": "https://res.cloudinary.com/path-to-file",
  "description": "Lorem ipsum dolor sit amet.",
  "socialLinks": {
    "facebook": "https://facebook.com/…",
    "linkedin": "https://linkedin.com/…",
    "twitter": "https://twitter.com/…",
    "youtube": "https://youtube.com/…",
  },
  "links": ["https://sample-domain.com"],
  "issue": {
    "raw": "<p>Lorem ipsum dolor <strong>sit amet</strong></p>",
    "plainText": "Lorem ipsum dolor sit amet",
    "files": ["https://*.cloudfront.net/path-to-file"]
  },
  "solution": {
    "raw": "<p>Lorem ipsum dolor <strong>sit amet</strong></p>",
    "plainText": "Lorem ipsum dolor sit amet",
    "files": ["https://*.cloudfront.net/path-to-file"]
  },
  "steps": [
    {
      "title": "Step title",
      "image": "https://res.cloudinary.com/path-to-file",
      "content": "Lorem ipsum dolor sit amet"
    }
  ],
  "freeSections": [
    {
      "raw": "<p>Lorem ipsum dolor <strong>sit amet</strong></p>",
      "plainText": "Lorem ipsum dolor sit amet"
    }
  ],
  "presentation": {
    "title": "Lorem ipsum dolor sit amet",
    "file": "https://sample-domain.com/path-to-file"
  },
  "media": ["imageId"],
  "customQuestions": {
    "6246c1bfe02d2c7d418c96e4": {
      answer: ["Choice #1", "Choice #2"],
      file: ""
    },
    "6246c1dee02d2c7d418c96ee": ["Lorem ipsum dolor sit amet."]
  },
  "votes": {
    "nbAllIn": 15,
    "nbPivot": 7,
    "nbKill": 4
  },
  "comments": 36
}