Webhooks FAQs
1. How are webhook URLs constructed?
Webhook URLs are formed by appending the topic name to your registered base URL:
{base_url}/{topic}2. What topic names should I use?
Use the supported topic values defined in the webhook topics documentation.
Examples include:
transfersvirtual_reference_number
Refer to the webhook topics page for the full list of supported topics.
3. Can I customize the endpoint path?
You can define the base URL. Newline appends the topic path to that base URL.
4. Can I include an API key in my webhook URL?
Yes, but it must be included within the base URL, before the topic path.
5. Can I append the API key after the topic path?
No. This is not currently supported and would require additional development.
6. Do webhook URLs include client or environment names?
No. Only the base URL you provide is used. No additional identifiers are added by Newline.
7. Why do some docs show MQ-style topic names?
Those formats are legacy and do not apply to webhooks.
Webhook delivery uses simplified topic names appended to your base URL. Each topic path functions as a distinct endpoint (for example, /transfers or /virtual_reference_number).
8. What happens if my API key changes?
You must update your registered base URL to reflect the new API key.
9. Do I need separate endpoints for each topic?
No. You register a single base URL, and Newline appends each topic path to that base URL.
Each topic is delivered to its own path (e.g., /transfers, /virtual_reference_number), so your system should be able to handle requests across these dynamic endpoints.