Webhooks

Set webhook URL

Set or update the webhook URL for receiving SMS notifications. When an SMS is received, your webhook will receive a POST request with the payload format shown in the response examples.

post/webhook

Request

  • Base URL: https://api.quackr.io
  • URL: https://api.quackr.io/webhook
  • Auth: API key in header x-api-key

Request body

webhookUrlstring uri required

Example request

{
  "webhookUrl": "https://example.com/webhook"
}

Response

Successfully set webhook URL. When SMS messages are received, your webhook endpoint will receive POST requests with the following payload structure:

successboolean

Example response

{
  "success": true
}

Changes

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