plugin-integrations
Create plugin integration
Creates a new plugin integration. As part of creation, Productboard sends a probe request (GET) to your configured action URL to verify it is reachable and intends to receive action notifications. See the callbacks section below.
The integration is created in the enabled state by default. Set fields.integrationStatus to disabled to skip the probe (useful for staged setup).
action is write-only: the action configuration, including any headers.authorization secret, is never returned in responses.
post/plugin-integrations
Request body
Example request
{
"data": {
"fields": {
"type": "com.example.myservice",
"name": "My Service Integration",
"integrationStatus": "enabled",
"initialState": {
"label": "Push"
},
"action": {
"url": "https://example.com/productboard-push",
"version": 1,
"headers": {
"authorization": "Bearer my-action-secret"
}
}
}
}
}Response
Plugin integration created successfully
Example response
{
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"links": {
"self": "https://api.productboard.com/v2/plugin-integrations/00000000-0000-0000-0000-000000000001",
"connections": "https://api.productboard.com/v2/plugin-integrations/00000000-0000-0000-0000-000000000001/connections"
}
}
}