Using Cryptix API Webhooks

Webhooks allow you to track updates to payments associated with your account. You can use webhooks to update a database record upon successful payment or to send an email to the customer after payment confirmation.

Cryptix sends webhook events whenever a payment is created, confirmed, or fails.

Subscribing to a Webhook

info

Operations PayIn and PayOut have different callback URLs.

PayIn

1. Go to the "My Projects" section.
2. When creating a project, specify the "callback_url" parameter.

You'll be prompted to enter callback URL for receiving notifications about the status of incoming transactions if necessary. The format of the URL is "https://mysite.com/home/callback".

PayOut

1. Go to the settings page in Cryptix.
2. Add an endpoint in the Webhook subscriptions section.
3. Click "Add endpoint" to add the URL where you want to receive webhooks.

You'll be prompted to enter callback URL for receiving notifications about the status of payout if necessary. The format of the URL is "https://mysite.com/home/callback".

Or specify the callback_url parameter in the MassPayouts method.

Receiving Webhooks

Before sending your webhook data, Cryptix checks the security of the connection to your service. For this to work, your server must be properly configured to support HTTPS.

Webhook Response

Your endpoint should respond with an HTTP 200 status code to confirm receiving the webhook. If there's no confirmation of receipt, we retry with an exponential backoff for up to three days. The maximum retry interval is one hour.

Signature Verification

Cryptix signs each webhook event it sends to your endpoints. The signature is included in the x-signature header. This header contains the SHA256 HMAC signature of the raw request payload, calculated using your webhook's shared secret code as the key.

You can find the shared webhook secret in the settings. Always verify the webhook signature before taking action within your system.