Monime Documentation

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>",
  "events": [
    "<string>"
  ],
  "isActive": false,
  "apiVersion": "<string>",
  "alertEmails": [
    "<string>"
  ],
  "verificationMethod": {
    "hmac256": {
      "secret": "<string>"
    }
  },
  "customHeaders": {},
  "metadata": {}
}
'

{
  "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

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. This header is used to uniquely identify a request, ensuring that the operation is not performed more than once during retries.

Maximum string 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 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

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.

⌘I

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>",
  "events": [
    "<string>"
  ],
  "isActive": false,
  "apiVersion": "<string>",
  "alertEmails": [
    "<string>"
  ],
  "verificationMethod": {
    "hmac256": {
      "secret": "<string>"
    }
  },
  "customHeaders": {},
  "metadata": {}
}
'

{
  "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": {}
  }
}

API Reference

Core Resources

Payins

Payouts

Utilities

Extra Resources

Financial Providers

Create Webhook

Authorizations

Headers

Body

Response