Sign in
Webhooks

Update Webhook

Changed on

Update the endpoint URL, description, enabled state, or event filters. Changes apply to future event matching.

put/v1/aggregators/{raast-aggregator-id}/webhooks/{webhook-id}

Request

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

Request body

urlstring uri

The final HTTPS URL where webhook events will be sent.

descriptionstring

Optional description for the webhook endpoint

event_typesstring[]

Replacement exact event names or trailing-wildcard category filters. Omit this property to preserve the current filters.

enabledboolean

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

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