Webhooks

Create a webhook

Subscribe a callback URL to project events. No callback is contacted in this demo.

post/webhooksv1

Authorization

Authentication is required. bearerAuth
Enter credentials in the playground. Reuse is optional and stays in memory.
Authorizationstringheaderrequired

Bearer authentication header. Use Bearer <token>, where <token> is your access token.

Request bodyrequiredapplication/json

object
urlstring · urirequired
eventsarrayrequired
Show child attributes
Array items string
string
Allowed values: "project.created""project.deleted"

Response

Webhook subscription created.

application/json
object
idstring
urlstring · uri
eventsarray
Show child attributes
Array items string
string
enabledboolean
Example response
Example response
{
  "id": "hook_polaris",
  "url": "https://example.com/webhooks",
  "events": [
    "project.created"
  ],
  "enabled": true
}
Source: openapi.yaml#/paths/~1webhooks/post
Built with doctopus

What would you like to build?

Search guides, endpoints, and parameters.