Update Webhook

PATCH /webhooks/{id}

Try it

Update Webhook

cURL

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 '
{
  "url": " https://api.company.com/webhooks",
  "name": "<string>",
  "isActive": true,
  "apiVersion": "<string>",
  "events": [
    "<string>"
  ],
  "alertEmails": [
    "<string>"
  ],
  "verificationMethod": {
    "hmac256": {
      "secret": "<string>"
    }
  },
  "customHeaders": {},
  "metadata": {}
}
'

200

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "name": "My Ecommerce Webhook",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "id": "<string>",
    "isActive": true,
    "apiVersion": "<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. The value is the tenancy parameter that Monime used to determine which space the request is intended for.

Maximum string length: 100

Path Parameters

id · string · required

The ID for the webhook object to update 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.

Required array length: 1 - 100 elements

alertEmails · string[] | null

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

Maximum array length: 3

verificationMethod · object

The verification method of the webhook.

Show child attributes

verificationMethod. hmac256 · object

A HMAC-256 method to verify the webhook

Show child attributes

verificationMethod.hmac256. secret · string · required

Secret used to verify the webhook's signature.

Required string length: 32 - 100

customHeaders · object

Custom headers of the webhook.

Show child attributes

customHeaders. {key} · string

metadata · object

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

Show child attributes

result. name · string · required

The name of the webhook.

Required string length: 1 - 100

Example:

"My Ecommerce Webhook"

result. url · string · required

The URL where the webhook events are sent.

result. events · string[] | null · required

The list of events that triggers the webhook.

result. id · string

The unique identifier for the webhook object

result. isActive · boolean

Denotes whether the webhook is active.

result. apiVersion · string

The API version the webhook supports.

result. alertEmails · string[] | null

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

result. verificationMethod · object

The verification method of the webhook.

Show child attributes

result.verificationMethod. hmac256 · object

A HMAC-256 method to verify the webhook

Show child attributes

result.verificationMethod.hmac256. secret · string · required

Secret used to verify the webhook's signature.

Required string length: 32 - 100

result. customHeaders · object

Custom headers of the webhook.

Show child attributes

result.customHeaders. {key} · string

result. createTime · string<date-time>

The creation time of the webhook.

result. metadata · object

This holds key-value pairs, where both the keys and values are strings not exceeding 64 and 100 characters respectively. This allows for flexible and descriptive tagging or additional information to be associated with the object.