Monime Documentation

POST

webhooks

Create Webhook

curl --request POST \
  --url https://api.monime.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '
{
  "name": "My Ecommerce Webhook",
  "url": "<string>",
  "apiRelease": "caph",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "headers": {},
  "alertEmails": [
    "<string>"
  ],
  "verificationMethod": {
    "type": "HS256",
    "secret": "<string>"
  },
  "metadata": {}
}
'

import requests

url = "https://api.monime.io/v1/webhooks"

payload = {
    "name": "My Ecommerce Webhook",
    "url": "<string>",
    "apiRelease": "caph",
    "events": ["<string>"],
    "enabled": True,
    "headers": {},
    "alertEmails": ["<string>"],
    "verificationMethod": {
        "type": "HS256",
        "secret": "<string>"
    },
    "metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Monime-Space-Id": "<monime-space-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'Monime-Space-Id': '<monime-space-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'My Ecommerce Webhook',
    url: '<string>',
    apiRelease: 'caph',
    events: ['<string>'],
    enabled: true,
    headers: {},
    alertEmails: ['<string>'],
    verificationMethod: {type: 'HS256', secret: '<string>'},
    metadata: {}
  })
};

fetch('https://api.monime.io/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.monime.io/v1/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Ecommerce Webhook',
    'url' => '<string>',
    'apiRelease' => 'caph',
    'events' => [
        '<string>'
    ],
    'enabled' => true,
    'headers' => [
        
    ],
    'alertEmails' => [
        '<string>'
    ],
    'verificationMethod' => [
        'type' => 'HS256',
        'secret' => '<string>'
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "Monime-Space-Id: <monime-space-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.monime.io/v1/webhooks"

	payload := strings.NewReader("{\n  \"name\": \"My Ecommerce Webhook\",\n  \"url\": \"<string>\",\n  \"apiRelease\": \"caph\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"headers\": {},\n  \"alertEmails\": [\n    \"<string>\"\n  ],\n  \"verificationMethod\": {\n    \"type\": \"HS256\",\n    \"secret\": \"<string>\"\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Monime-Space-Id", "<monime-space-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.monime.io/v1/webhooks")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Monime-Space-Id", "<monime-space-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Ecommerce Webhook\",\n  \"url\": \"<string>\",\n  \"apiRelease\": \"caph\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"headers\": {},\n  \"alertEmails\": [\n    \"<string>\"\n  ],\n  \"verificationMethod\": {\n    \"type\": \"HS256\",\n    \"secret\": \"<string>\"\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.monime.io/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Monime-Space-Id"] = '<monime-space-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Ecommerce Webhook\",\n  \"url\": \"<string>\",\n  \"apiRelease\": \"caph\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"headers\": {},\n  \"alertEmails\": [\n    \"<string>\"\n  ],\n  \"verificationMethod\": {\n    \"type\": \"HS256\",\n    \"secret\": \"<string>\"\n  },\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "<string>",
    "name": "My Ecommerce Webhook",
    "url": "<string>",
    "enabled": true,
    "events": [
      "<string>"
    ],
    "apiRelease": "caph",
    "verificationMethod": {
      "type": "HS256",
      "secret": "<string>"
    },
    "headers": {},
    "alertEmails": [
      "<string>"
    ],
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

Maximum string length: 64

Monime-Version

enum<string> | null

Specifies which version of the Monime API will handle this request.

Available options:

caph.2025-08-23,

caph.2025-06-20

Monime-Space-Id

string

required

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

Maximum string length: 64

Pattern: ^spc-.*$

Body

application/json

Create a new webhook with configuration for target URL, events, headers, and security.

name

string

required

Human-readable name for the webhook configuration.

Required string length: 1 - 100

Example:

"My Ecommerce Webhook"

url

string

required

Target URL that will receive webhook event payloads.

Maximum string length: 255

apiRelease

enum<string>

default:caph

required

Defines the target API release for this webhook. A release represents a stable snapshot of the API schema. Ensures the webhook receives the latest object schema for a given release cycle.

Available options:

caph,

siriusb

events

string[] | null

required

List of event types that should trigger this webhook.

Required array length: 1 - 100 elements

enabled

boolean

default:true

Flag indicating if the webhook should be active upon creation.

headers

object | null

Optional HTTP headers to include in outbound webhook requests.

Show child attributes

alertEmails

string[] | null

Optional email addresses to notify on repeated delivery failures.

Maximum array length: 2

verificationMethod

HMAC SHA256 · object

Method to be use to verify the integrity of incoming webhook requests.

HMAC SHA256
ECDSA SHA256

Show child attributes

metadata

object | null

Custom metadata for tagging or annotating this webhook.

Show child attributes

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

Webhook · object

A Webhook is a user-defined HTTP endpoint that Monime invokes with a POST request whenever specific events occur, such as payment.completed or payout.failed.
Webhooks allow you to receive real-time notifications and integrate Monime’s event stream directly into your own systems.

Use Cases

Realtime Payment Updates
Receive an immediate notification when a payment succeeds and update your user’s dashboard without polling the API.
Automated Payout Reconciliation
Trigger accounting workflows or ERP system updates when a payout is marked as completed or failed.
Fraud & Risk Monitoring
Stream payment events into your fraud detection system as they happen.

Show child attributes

Create Webhook

curl --request POST \
  --url https://api.monime.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '
{
  "name": "My Ecommerce Webhook",
  "url": "<string>",
  "apiRelease": "caph",
  "events": [
    "<string>"
  ],
  "enabled": true,
  "headers": {},
  "alertEmails": [
    "<string>"
  ],
  "verificationMethod": {
    "type": "HS256",
    "secret": "<string>"
  },
  "metadata": {}
}
'

import requests

url = "https://api.monime.io/v1/webhooks"

payload = {
    "name": "My Ecommerce Webhook",
    "url": "<string>",
    "apiRelease": "caph",
    "events": ["<string>"],
    "enabled": True,
    "headers": {},
    "alertEmails": ["<string>"],
    "verificationMethod": {
        "type": "HS256",
        "secret": "<string>"
    },
    "metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Monime-Space-Id": "<monime-space-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'Monime-Space-Id': '<monime-space-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'My Ecommerce Webhook',
    url: '<string>',
    apiRelease: 'caph',
    events: ['<string>'],
    enabled: true,
    headers: {},
    alertEmails: ['<string>'],
    verificationMethod: {type: 'HS256', secret: '<string>'},
    metadata: {}
  })
};

fetch('https://api.monime.io/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.monime.io/v1/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Ecommerce Webhook',
    'url' => '<string>',
    'apiRelease' => 'caph',
    'events' => [
        '<string>'
    ],
    'enabled' => true,
    'headers' => [
        
    ],
    'alertEmails' => [
        '<string>'
    ],
    'verificationMethod' => [
        'type' => 'HS256',
        'secret' => '<string>'
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "Monime-Space-Id: <monime-space-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.monime.io/v1/webhooks"

	payload := strings.NewReader("{\n  \"name\": \"My Ecommerce Webhook\",\n  \"url\": \"<string>\",\n  \"apiRelease\": \"caph\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"headers\": {},\n  \"alertEmails\": [\n    \"<string>\"\n  ],\n  \"verificationMethod\": {\n    \"type\": \"HS256\",\n    \"secret\": \"<string>\"\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Monime-Space-Id", "<monime-space-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.monime.io/v1/webhooks")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Monime-Space-Id", "<monime-space-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Ecommerce Webhook\",\n  \"url\": \"<string>\",\n  \"apiRelease\": \"caph\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"headers\": {},\n  \"alertEmails\": [\n    \"<string>\"\n  ],\n  \"verificationMethod\": {\n    \"type\": \"HS256\",\n    \"secret\": \"<string>\"\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.monime.io/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Monime-Space-Id"] = '<monime-space-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Ecommerce Webhook\",\n  \"url\": \"<string>\",\n  \"apiRelease\": \"caph\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"enabled\": true,\n  \"headers\": {},\n  \"alertEmails\": [\n    \"<string>\"\n  ],\n  \"verificationMethod\": {\n    \"type\": \"HS256\",\n    \"secret\": \"<string>\"\n  },\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "<string>",
    "name": "My Ecommerce Webhook",
    "url": "<string>",
    "enabled": true,
    "events": [
      "<string>"
    ],
    "apiRelease": "caph",
    "verificationMethod": {
      "type": "HS256",
      "secret": "<string>"
    },
    "headers": {},
    "alertEmails": [
      "<string>"
    ],
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

API Reference

Core Resources

Payins

Payouts

Utilities

Extra Resources

Financial Providers

Create Webhook

Authorizations

Headers

Body

Response

Use Cases