Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
Webhooks

Creates a new Webhooks for the project environment

post/environments/{environmentId}/webhooks

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Request body

urlstring required
isEnabledboolean required
eventsNonEmptyStringWith255MaxLength[] required

Example request

{
  "url": "https://website-sample.com",
  "events": [
    "An example name"
  ]
}

Response

Successfully created

environmentIdstring required
webhookIdstring required
urlstring required
secretstring
versionstring
eventsstring[] required
isEnabledboolean required
enabledAtstring date-time
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "environmentId": "95b11417-f18f-457f-8804-68e361f9164f",
  "webhookId": "95b11417-f18f-457f-8804-68e361f9164f",
  "url": "https://website-sample.com"
}