Create a webhook

POST /groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks

Token auth

Create a webhook.

Path parameters

groupId string Required

An Atlas Project/Group ID.
appId string Required

The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
serviceId string Required

The unique _id value of a service.

application/json

Body Required

The webhook to create.

name string Required
function_source string Required
respond_result boolean Required
options object
Hide options attributes Show options attributes object
- secret string
- secretAsQueryParam boolean

Responses

201

Successfully created.

POST /groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks

curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"string","function_source":"string","respond_result":true,"options":{"secret":"string","secretAsQueryParam":true}}'

Request examples

{
  "name": "string",
  "function_source": "string",
  "respond_result": true,
  "options": {
    "secret": "string",
    "secretAsQueryParam": true
  }
}