API

Add WebHook

post
https://api.aurorasendcloud.com/api/webhook/add

Create a new webHook for real-time email event notifications. Each WebHook can only bind one event type; multiple event types require creating multiple WebHooks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Where to Find WebHook Event Codes

For the list of supported WebHook event codes and their corresponding event types, see Supported Event Codes.


Form Data
string
required
length ≤ 1024
^https?://.*

Callback URL. Must be a valid http(s) URL. Maximum 1024 characters (inclusive; 1024 accepted, 1025 rejected).

string
required

Associated API_USER (required)

string

Event types (comma-separated valid event codes; defaults to all if not filled). Valid codes: 1, 3, 4, 5, 7, 10, 11, 12, 18, 81, 83. No leading or empty tokens (a leading comma or empty element returns WEBHOOK_EVENTTYPELIST_INCORRECT (40704)); a trailing comma is tolerated. Whitespace around tokens is trimmed. Code 25 (Inbound Route) is a default event and not subscribable; including it returns WEBHOOK_EVENTTYPELIST_INCORRECT (40704).

Responses

Updated 18 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?