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

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

​
Monime-Space-Id
string
required

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

Maximum length: 100
​
Idempotency-Key
string
required

This header is used to uniquely identify a request, ensuring that the operation is not performed more than once during retries.

Maximum length: 64

Body

application/json
​
name
string
required

The name of the webhook.

Required string length: 1 - 100
​
url
string
required

The URL of the webhook

​
events
string[] | null
required

The list of events the webhook is subscribed to.

Required array length: 1 - 100 elements
​
isActive
boolean
default:false

Denotes whether the webhook is active.

​
apiVersion
string

The API version the webhook supports.

​
alertEmails
string[] | null

The list email address to send alert notifications to when the webhook is failing.

Maximum length: 3
​
verificationMethod
object | null

The verification method of the webhook.

​
customHeaders
object | null

Custom headers of the webhook.

​
metadata
object | null

Metadata attributes of the webhook.

Response

200 - application/json

OK

​
success
boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

​
messages
any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

​
result
object