MEmendix
webhook

Create a new webhook

Create a new webhook for the app. The response will return the unique Id of the created webhook.

post/apps/{app-id}/webhooks

Request

  • Base URL
    https://webhook-portal.home.mendix.com/api/v1
  • Auth
    none declared

Request body

namestring required
urlstring required
eventTypesstring[] required
isActiveboolean required
validationSecretstring required

Example request

{
  "url": "https://some.domain.com/webhooks",
  "eventTypes": [
    "teamserver.push"
  ],
  "validationSecret": "PMJhiGo1nTL6wlNyZVFh5v9rLZdcLsG2O",
  "headers": [
    {
      "key": "Authorization",
      "value": "Beaerer DG4R4GT6R43"
    }
  ]
}

Response

OK

idstring required

The unique Id of a webhook

namestring required
urlstring required
eventTypesstring[] required
isActiveboolean required
validationSecretstring required

Example response

{
  "id": "mxep_mfiHo9gZw6RcGisubUfhyfuCllim5q",
  "url": "https://some.domain.com/webhooks",
  "eventTypes": [
    "teamserver.push"
  ],
  "headers": [
    {
      "key": "Authorization",
      "value": "Beaerer DG4R4GT6R43"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.