Sign in
Webhooks

Create Webhook

Changed on

Register an endpoint for exact event names or trailing-wildcard filters such as payment.*. The response contains the base64-encoded signing secret. Store it securely and decode it before using the bytes as the HMAC-SHA256 key.

post/v1/aggregators/{raast-aggregator-id}/webhooks

Request

  • Base URL: https://api.getsafepay.com/raastwire
  • URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks
  • Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Path parameters

raast-aggregator-idstring required
Example:agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e

The unique identifier for the aggregator

Request body

urlstring uri required

The final HTTPS URL where webhook events will be sent.

descriptionstring

Optional description for the webhook endpoint

event_typesstring[] required

Exact public event names or trailing-wildcard category filters such as payment.*, refund.*, or settlement.*.

enabledboolean

Whether the webhook endpoint should be enabled immediately

Example request

{
  "url": "https://api.example.com/webhooks/safepay",
  "description": "Raast production webhook",
  "event_types": [
    "payment.*",
    "refund.*"
  ],
  "enabled": true
}

Response

This response contains details of a Webhook

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "secret": "9sU3KVM5iQYZsxt40st1nkJsvbyuLnquB3Re1Q7k08w="
  }
}

Changes

  • 39ef091c287fRevision changes
    • breaking

      the request property format changed from no format to uri

    • warning

      removed the optional property /// from the response with the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the /// response's property pattern ^agg_ was added for the status

    • info

      the /// response's property pattern ^wh_ was added for the status

  • e54fafc46fd7Revision changes
    • info

      endpoint added