Skip to main content
POST
/
v1
/
aggregators
/
{raast-aggregator-id}
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>' \
  --data '
{
  "url": "https://github.com/HasCold",
  "description": "this is testing url endpoint",
  "event_types": [
    "payment.created"
  ],
  "enabled": true
}
'
{
  "api_version": "v1",
  "data": {
    "endpoint": {
      "token": "wh_f52d84b4-a140-4a3a-b707-80644232e926",
      "aggregator_id": "agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e",
      "url": "https://github.com/HasCold",
      "description": "this is testing url endpoint",
      "enabled": true,
      "event_filter_json": "[\"payment.created\"]",
      "created_at": "2025-12-02T12:48:35.416597859Z",
      "updated_at": "2025-12-02T12:48:35.416597859Z",
      "secret": "9sU3KVM5iQYZsxt40st1nkJsvbyuLnquB3Re1Q7k08w=",
      "secret_version": 1,
      "secret_rotated_at": "2025-12-02T12:48:35.416597859Z"
    },
    "secret": "9sU3KVM5iQYZsxt40st1nkJsvbyuLnquB3Re1Q7k08w="
  }
}

Authorizations

​
X-SFPY-AGGREGATOR-SECRET-KEY
string
header
required

Path Parameters

​
raast-aggregator-id
string
required

The unique identifier for the aggregator

Example:

"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e"

Body

application/json

Request to create a webhook endpoint

Parameters for creating a webhook endpoint

​
url
string
required

The URL where webhook events will be sent

Example:

"https://github.com/HasCold"

​
event_types
string[]
required

List of event types to subscribe to

Example:
[
  "payment.created",
  "payment.completed",
  "refund.completed",
  "refund.created",
  "settlement.processing",
  "settlement.completed"
]
​
description
string

Optional description for the webhook endpoint

Example:

"this is testing url endpoint"

​
enabled
boolean

Whether the webhook endpoint should be enabled immediately

Example:

true

Response

This response contains details of a Webhook

Standard response structure for successful operations

​
api_version
string

The current version of the API spec

Example:

"v1"

​
data
object

Contains the response data