API
Checking Raims account

Create a webhook

Register a destination to receive selected events from your company.

POSThttps://api.raims.com/v1/webhooks

Register a receiving URL and select the events your integration needs to follow. Keep the returned secret in a private application environment: configuration queries do not return this value. If the receiver is not ready yet, register it with is_active: false.

See Register a destination and Receive and validate events before starting to receive notifications.

Body Params

Name to identify the destination.

1 to 25 characters

HTTPS URL that receives events. Use the default port 443 and a public address outside Raims.

1 to 512 characters

Codes of the events this destination should receive. Query the available event catalog.

charge.paid

Defines whether the destination can receive events after creation.

true

Responses

For common errors, see HTTP response codes.