Webhooks

Get all webhooks

get

Responses

200

Success

application/json

_idstringOptional

Unique identifier of the webhook.

urlstring · urlOptional

URL where the webhook will receive notifications.

eventsstring[]Optional

array with events name

get

/webhooks

HTTPcURLJavaScriptPython

GET /api/webhooks HTTP/1.1
Accept: */*

200

Success

[
  {
    "_id": "text",
    "url": "text",
    "events": [
      "text"
    ]
  }
]

Create a new webhook

post

Body

application/json

_idstringOptional

Unique identifier of the webhook.

urlstring · urlOptional

URL where the webhook will receive notifications.

eventsstring[]Optional

array with events name

Responses

201

A webhook id

application/json

post

/webhooks

HTTPcURLJavaScriptPython

POST /api/webhooks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "_id": "text",
  "url": "text",
  "events": [
    "text"
  ]
}

201

A webhook id

{
  "id": "text"
}

Get a webhook by id

get

Path parameters

idstringRequired

Responses

200

Success

application/json

_idstringOptional

Unique identifier of the webhook.

urlstring · urlOptional

URL where the webhook will receive notifications.

eventsstring[]Optional

array with events name

get

/webhooks/{id}

HTTPcURLJavaScriptPython

GET /api/webhooks/{id} HTTP/1.1
Accept: */*

200

Success

{
  "_id": "text",
  "url": "text",
  "events": [
    "text"
  ]
}

Update a webhook by id

put

Path parameters

idstringRequired

Responses

204

Success

put

/webhooks/{id}

HTTPcURLJavaScriptPython

PUT /api/webhooks/{id} HTTP/1.1
Accept: */*

204

Success

No content

Delete a webhook by id

delete

Path parameters

idstringRequired

Responses

204

Success

delete

/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /api/webhooks/{id} HTTP/1.1
Accept: */*

204

Success

No content