List Webhooks

Retrieve a list of all webhooks.

GET /webhooks

Try it

List Webhooks

cURL

curl --request GET \
  --url https://api.monime.io/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'

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": {}
    }
  ],
  "pagination": {
    "count": 1,
    "total": 1,
    "next": "<string>"
  }
}

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

Query Parameters

after · string | null

This identifier retrieves the next items in the total result list that come just after it. Use it to get items that follows the object having this identifier in the overall list. This takes precedence over 'before'. This identifier retrieves the next items in the total result list that come just after it. Use it to get items that follows the object having this identifier in the overall list. This takes precedence over 'before'.

Maximum string length: 100

before · string | null

This identifier retrieves the next items in the total result list that comes just before it. Use it to get items that precede the object having this identifier in the overall list. This identifier retrieves the next items in the total result list that comes just before it. Use it to get items that precede the object having this identifier in the overall list.

Maximum string length: 100

limit · integer · default: 10

The maximum number of items per page that should be retrieved from the result list. The maximum number of items per page that should be retrieved from the result list.

Required range: 1 <= x <= 50

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[] | null

The list of items in the response

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.

pagination · object

The pagination info associated with the response

Show child attributes

pagination. count · integer

The number of items in this list response.

Required range: x >= 0

pagination. total · integer | null

The estimated total number of items matching the request.

Required range: x >= 0

pagination. next · string | null

This identifier marks the first item in this response list when moving backward through the results, or the last item when moving forward. Use this identifier with the 'after' or 'before' query parameter in your next request to get the items that come after or before this item in the overall list respectively.