Crypto Ramp API
Create a webhook
api
post
/webhooks

Create a webhook

Create a webhook so that Ramp can push event notifications to the specified URL.

For more information, see the guides: Work with webhooks -> Track order and payment lifecycle.

X-API-KEY​

Each Crypto Ramp API request must contain an authorization header in the following format to make a call: X-API-KEY: {your_API_key}.

Before you start, make sure that you have the correct API key. For more information, see the Get started guides: Integrate with Revolut Ramp -> 2. Get Partner keys.

Request​

Header Parameters
Header Parameters

Your API key that you received during integration setup. For more information, see the Authorization section above.

Request body
Body object

The webhook's URL to which event notifications will be sent. Must be a valid HTTP or HTTPS URL, capable of receiving POST requests.

Possible values: [ORDER_CREATED, ORDER_PROCESSING, ORDER_COMPLETED, ORDER_FAILED]

The list of event types that the webhook is configured to listen to.

Response​

The successfully created webhook

Response body
Body object

The UUID of the webhook.

The webhook's URL to which event notifications will be sent. Must be a valid HTTP or HTTPS URL, capable of receiving POST requests.

Possible values: [ORDER_CREATED, ORDER_PROCESSING, ORDER_COMPLETED, ORDER_FAILED]

The list of event types that the webhook is configured to listen to.

The signing secret for the webhook. Use it to verify the signature for the webhook's request payload.

Was this page helpful?
Loading...