Skip to main content

Webhooks

Create a Webhook​

You can define one or multiple webhooks that can trigger at specified times and send pre-defined payloads and headers to specified endpoints. This is particularly useful for automating repetitive tasks or for integrating multiple services.

curl --location 'https://api.ripplesignal.co/webhooks' \
--header 'x-secret-key: xxx' \
--header 'Content-Type: application/json' \
--data '{
    "webhooks": [{"name": "webhook_name", "endpoint_url": "https://your_url/", "headers": {}, "payload": "{\"key\": \"value\"}", "run_at": "2023-07-09T20:00:00"}, ...]
}'

Webhook Parameters

  • name: The name of the webhook.
  • endpoint_url: The endpoint to which the webhook will send data.
  • headers: Any optional HTTP headers you want to include in the webhook request.
  • payload: The data payload, formatted as a JSON object.
  • run_at: The specific time you want the webhook to run, formatted in ISO-8601.

Cancel a Webhook​

If you have webhooks that are scheduled but not yet executed, you may want to cancel them. Use this API to cancel one or more webhooks by specifying their IDs.

curl --location 'https://api.ripplesignal.co/webhooks/cancel' \
--header 'x-secret-key: xxx' \
--header 'Content-Type: application/json' \
--data '{
    "webhook_ids": ["your_webhook_id"]
}'

Search Webhooks​

This API allows you to search through your existing webhooks based on various filters. You can also specify the sorting order for the returned results.

curl --location 'https://api.ripplesignal.co/webhooks/search' \
--header 'x-secret-key: xxx' \
--header 'Content-Type: application/json' \
--data '{
    "filters": { /* Your filter criteria */ },
    "sort": {
        "columns": ["created_at"],
        "order": "desc"
    }
}'