Skip to main content
POST
/
v1
/
webhook-endpoints
Create a webhook endpoint
curl --request POST \
  --url https://api.scrip.dev/v1/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "enabled_events": [
    "balance.credited",
    "balance.debited"
  ],
  "url": "https://example.com/webhooks",
  "description": "Production webhook receiver",
  "metadata": "<unknown>"
}
'
import requests

url = "https://api.scrip.dev/v1/webhook-endpoints"

payload = {
"enabled_events": ["balance.credited", "balance.debited"],
"url": "https://example.com/webhooks",
"description": "Production webhook receiver",
"metadata": "<unknown>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled_events: ['balance.credited', 'balance.debited'],
url: 'https://example.com/webhooks',
description: 'Production webhook receiver',
metadata: '<unknown>'
})
};

fetch('https://api.scrip.dev/v1/webhook-endpoints', 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.scrip.dev/v1/webhook-endpoints",
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([
'enabled_events' => [
'balance.credited',
'balance.debited'
],
'url' => 'https://example.com/webhooks',
'description' => 'Production webhook receiver',
'metadata' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$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.scrip.dev/v1/webhook-endpoints"

payload := strings.NewReader("{\n \"enabled_events\": [\n \"balance.credited\",\n \"balance.debited\"\n ],\n \"url\": \"https://example.com/webhooks\",\n \"description\": \"Production webhook receiver\",\n \"metadata\": \"<unknown>\"\n}")

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

req.Header.Add("X-API-Key", "<api-key>")
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.scrip.dev/v1/webhook-endpoints")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled_events\": [\n \"balance.credited\",\n \"balance.debited\"\n ],\n \"url\": \"https://example.com/webhooks\",\n \"description\": \"Production webhook receiver\",\n \"metadata\": \"<unknown>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrip.dev/v1/webhook-endpoints")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled_events\": [\n \"balance.credited\",\n \"balance.debited\"\n ],\n \"url\": \"https://example.com/webhooks\",\n \"description\": \"Production webhook receiver\",\n \"metadata\": \"<unknown>\"\n}"

response = http.request(request)
puts response.read_body
{
  "circuit_broken_until": "2026-01-15T10:40:00Z",
  "created_at": "2026-01-15T10:30:00Z",
  "description": "Production webhook receiver",
  "enabled_events": [
    "balance.credited",
    "balance.debited"
  ],
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "metadata": "<unknown>",
  "rate_limited_until": "2026-01-15T10:35:00Z",
  "secret": "whsec_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
  "status": "ACTIVE",
  "updated_at": "2026-01-15T10:30:00Z",
  "url": "https://example.com/webhooks"
}
{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}
{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}
{
"code": "forbidden",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Insufficient permissions for this action"
}
{
"code": "unsupported_media_type",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Content-Type must be application/json"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}
Registers a new webhook endpoint. You must provide an HTTPS URL and at least one event type (or * for all events). The response includes a secret starting with whsec_; store it immediately, as it cannot be retrieved later. URLs are validated at creation time. The hostname must resolve to a public IP address. Private ranges, loopback addresses, and reserved hostnames (localhost, *.local, *.internal) are rejected.
For signature verification, event types, and payload shapes, see the Webhooks guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Body

application/json

Endpoint configuration

enabled_events
string[]
required

Event types to subscribe to (use * for all)

Minimum array length: 1
Example:
["balance.credited", "balance.debited"]
url
string
required

HTTPS URL that will receive webhook deliveries

Minimum string length: 1
Example:

"https://example.com/webhooks"

description
string

Human-readable label for this endpoint

Example:

"Production webhook receiver"

metadata
any

Arbitrary key-value metadata to attach to this endpoint

Response

Endpoint created (includes secret)

circuit_broken_until
string

When set and in the future, the circuit breaker has paused deliveries to this endpoint until this time (sustained delivery failures)

Example:

"2026-01-15T10:40:00Z"

created_at
string<date-time>

When the endpoint was created

Example:

"2026-01-15T10:30:00Z"

description
string

Human-readable label

Example:

"Production webhook receiver"

enabled_events
string[]

Subscribed event types

Example:
["balance.credited", "balance.debited"]
id
string<uuid>

Endpoint ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

metadata
any

Arbitrary metadata

rate_limited_until
string

When set and in the future, 429 rate-limit backoff has paused deliveries to this endpoint until this time

Example:

"2026-01-15T10:35:00Z"

secret
string

Signing secret (only returned on create and rotate — store it immediately)

Example:

"whsec_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"

status
string

Lifecycle status: ACTIVE, DISABLED, or ARCHIVED

Example:

"ACTIVE"

updated_at
string<date-time>

When the endpoint was last modified

Example:

"2026-01-15T10:30:00Z"

url
string

Destination URL for deliveries

Example:

"https://example.com/webhooks"