PATCH
/
webhooks
/
{id}
curl --request PATCH \
  --url https://api.monime.io/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '{
  "name": "<string>",
  "url": " https://api.company.com/webhooks",
  "isActive": true,
  "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

Path Parameters

​
id
string
required

The ID for the webhook object to update

Body

application/json
​
url
string
required

The URL where the webhook events are sent.

Example:

" https://api.company.com/webhooks"

​
name
string | null

The name of the webhook.

Required string length: 1 - 100
​
isActive
boolean | null

Denotes whether the webhook is active.

​
apiVersion
string | null

The API version the webhook supports.

​
events
string[] | null

The list of events that triggers the webhook.

​
alertEmails
string[] | null

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

​
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

Was this page helpful?

Suggest editsRaise issue