POST
/
v1
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.monime.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '{
  "name": "My Ecommerce Webhook",
  "url": "<string>",
  "enabled": true,
  "apiRelease": "<string>",
  "events": [
    "<string>"
  ],
  "headers": {},
  "alertEmails": [
    "<string>"
  ],
  "verificationMethod": {
    "type": "HS256",
    "secret": "<string>"
  },
  "metadata": {}
}'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": {
    "id": "<string>",
    "name": "My Ecommerce Webhook",
    "url": "<string>",
    "enabled": true,
    "events": [
      "<string>"
    ],
    "apiRelease": "<string>",
    "verificationMethod": {
      "type": "HS256",
      "secret": "<string>"
    },
    "headers": {},
    "alertEmails": [
      "<string>"
    ],
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string
required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

Maximum length: 64
​
Monime-Space-Id
string
required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum length: 64

Body

application/json

Create a new webhook with configuration for target URL, events, headers, and security.

Response

200 - application/json

OK

The response is of type object.