Signals

Send a test payload to a signal's webhook

Deliver a sample lead to the signal's configured webhookUrl so you can verify your endpoint before real leads arrive. Input: signalId in the path; optional body {"url": "..."} to test another endpoint than the saved webhookUrl (for example before saving it). The URL must be HTTP(S) and reachable from the internet. Output: success, the statusCode your endpoint returned, the exact payloadSent (it carries is_test: true so you can discard it), and the first bytes of your responseBody. signed tells whether the request carried the X-Webhook-Signature / X-Webhook-Timestamp headers: when no API key is linked to the signal the test is sent unsigned, like real deliveries, and warning says so. On a transport failure success is false and error explains why.

post/api/v1/signals/{signal_id}/test-webhook

Request

Base URL: https://api.rodz.io (the document declares no server; this is the origin it was published from)
URL: https://api.rodz.io/api/v1/signals/{signal_id}/test-webhook
Auth: HTTP bearer

Path parameters

signal_idstring required

Request body

urlstring nullable

Endpoint to test instead of the signal's saved webhook URL

Example request

{
  "url": "https://hooks.example.com/rodz/leads"
}

Response

Successful Response

successboolean required

True when your endpoint answered with a 2xx/3xx

statusCodeinteger nullable

HTTP status your endpoint returned

payloadSentobject nullable

The exact test payload delivered, carrying is_test: true

responseBodystring nullable

First bytes of your endpoint's response

errorstring nullable

Why the send failed; absent on success

signedboolean

True when the request carried the X-Webhook-Signature and X-Webhook-Timestamp headers. False when no API key is linked to the signal: the test (like real deliveries) is then sent unsigned.

warningstring nullable

Something to fix even though the send worked, e.g. an unsigned delivery

Example response

{
  "payloadSent": {
    "contact": "",
    "signal": {
      "type": "fundraising"
    }
  },
  "responseBody": "ok",
  "signed": true,
  "statusCode": 200,
  "success": true
}

Changes

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