Sign in

v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB
Webhooks

Create Webhook

Create a new Webhook

post/v1/projects/{project}/webhooks

Path parameters

projectstring required

A Project key or ID

Request body

namestring required

The name of the Webhook

descriptionstring

The description of the Webhook

outputFormatobject
_featurestring
_environmentsstring[]
eventsstring[] required

The events that trigger the webhook

urlstring required

The URL to call once the type is triggered

Example request

{
  "name": "Slack",
  "description": "Post in Slack when a feature is updated",
  "events": [
    "createdFeature",
    "modifiedFeature"
  ],
  "url": "https://hooks.slack.com/services/..."
}

Response

namestring required

The name of the Webhook

descriptionstring

The description of the Webhook

_idstring required

A unique Webhook ID

_projectstring required

The Project owning the Webhook

_featurestring

Events in this webhook will only be triggered for this feature

_environmentsstring[] required

Events in this webhook will only be triggered for these environments

urlstring required

The URL to call once the type is triggered

eventsstring[] required

The events that trigger the webhook

source'api' | 'dashboard' | 'importer' | 'github.code_usages' | 'github.pr_insights' | 'gitlab.code_usages' | 'gitlab.pr_insights' | 'bitbucket.code_usages' | 'bitbucket.pr_insights' | 'terraform' | 'cli' | 'slack' | 'mcp'

Source where webhook was created from

createdBystring

Auth0 User who created the webhook.

createdAtstring date-time required

The date the webhook was created, set by the API

updatedAtstring date-time required

The date the webhook was last updated, set by the API

outputFormatobject

The type of format to send the payload changes in

_slackIntegrationstring

The Slack Integration ID if the Webhook is created from a Slack command

Example response

{
  "name": "Slack",
  "description": "Post in Slack when a feature is updated",
  "_id": "61450f3daec96f5cf4a49946",
  "_project": "61450f3daec96f5cf4a49955",
  "_feature": "61450f3daec96f5cf4a49956",
  "url": "https://hooks.slack.com/services/...",
  "events": [
    "createdFeature",
    "modifiedFeature"
  ],
  "source": "dashboard",
  "createdBy": "auth0|61450f3daec96f5cf4a49955",
  "createdAt": "2021-09-17T16:47:01.000Z",
  "updatedAt": "2021-09-17T16:47:01.000Z"
}