Create a new subscription

post https://api.productboard.com/webhooks

Creates a new webhook subscription to be actively notified on each change in the specified entities.

Part of the subscription process is a probe request to verify that the referenced service really intends to receive the webhook notifications and that the requests will be able to reach the destination, see the callback section below for details.

Responses

Response body

object

data

object

required

string

required

Entity identifier.

createdAt

date-time

required

Timestamp

name

string

required

length between 1 and 255

Human-readable label for this webhook subscription, i.e. just anything that can help you to identify it easily.

events

array of objects

required

length ≥ 1

Event types triggerring this webhook.

events*

object

eventType

string

required

Describes type of an event that can trigger a webhook notification:

component.created- triggered whenever a component is created
component.updated - triggered whenever a component is updated
feature.created - triggered whenever a feature is created (This includes conversion from a component.)
feature.updated - triggered whenever a feature is updated
feature.deleted - triggered whenever a feature is deleted (This includes conversion to a component.)
feature-release-assignment.updated - triggered whenever a feature release assignment is updated (a feature is added to a release, a feature is removed from a release). The event of this type doesn't have id set, just target link.
hierarchy-entity.custom-field-value.updated - triggered whenever a custom field value for hierarchy entity is updated (This includes unsetting the value). The event of this type doesn't have id set, just target link.
note.created - triggered whenever a note is created
note.updated - triggered whenever a note is updated
note.deleted - triggered whenever a note is deleted
insight.created - triggered whenever a insight is created
insight.deleted - triggered whenever a feature is deleted
product.created - triggered whenever a product is created
product.updated - triggered whenever a product is updated
release.created - triggered whenever a release is created
release.updated - triggered whenever a release is updated
release.deleted - triggered whenever a release is deleted
key-result.created - triggered whenever a key result is created
key-result.updated - triggered whenever a key result is updated
key-result.deleted - triggered whenever a key result is deleted
objective.created - triggered whenever an objective is created
objective.updated - triggered whenever an objective is updated
objective.deleted - triggered whenever an objective is deleted
initiative.created - triggered whenever an initiative is created
initiative.updated - triggered whenever an initiative is updated
initiative.deleted - triggered whenever an initiative is deleted

component.created component.updated feature.created feature.updated feature.deleted feature-release-assignment.updated hierarchy-entity.custom-field-value.updated note.created note.updated note.deleted product.created product.updated release.created release.updated release.deleted insight.created insight.deleted key-result.created key-result.updated key-result.deleted objective.created objective.updated objective.deleted initiative.created initiative.updated initiative.deleted

Callbacks

Language

Credentials

Bearer

JWT


xxxxxxxxxx
19
1
curl --request POST \
2
     --url https://api.productboard.com/webhooks \
3
     --header 'X-Version: 1' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "data": {
9
    "events": [
10
      {
11
        "eventType": "component.created"
12
      }
13
    ],
14
    "notification": {
15
      "version": 1
16
    }
17
  }
18
}
19
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The webhook subscription has been successfully created.

400Bad request.