RAratepay
Endpoints

Endpoint to create a new subscription.

Creates a new webhook subscription accessible only to the client.

post/webhook/management/v1

Request

  • Base URL
    https://api-integration.ratepay.com
  • URL
    https://api-integration.ratepay.com/webhook/management/v1
  • Auth
    HTTP bearer

Headers

Authorizationstring required

For each request, a valid access token must be provided in the Authorization header. See Authentication API for obtaining a valid token.

Request body

urlUrl required(unresolved $ref)
event_typeEventType required(unresolved $ref)
secretSecret required(unresolved $ref)

Response

The subscription was created.

idstring

ID of the subscription.

urlstring url

HTTP URL to execute the webhook call with the POST method.

event_typestring

Type of the event to process by calling the API endpoint.

secretstring

Parameter given by the client to sign their payloads. Recommended to be unique for each URL.

Example response

{
  "id": "d8znR1k1_0Kw305BsoPT",
  "url": "https://api.merchant.com/event",
  "event_type": "INVOICE_INVOICE",
  "secret": "6GHbLH4d1Nx3eIs5CyLHCW4HuFi1qttpNSDawHKHlW7kurTpaddarwEKDWUI59IU"
}

Changes

No recorded changes to this operation across all 1 revision of this API.