Add WebHook

post

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

Create a new WebHook for real-time email event notifications. One request accepts one or more event codes in event: all codes are stored as a single WebHook group sharing one group id (returned as id), and the response's eventTypeMap lists every event in the group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

url

string

required

length ≤ 1024

^https?://.*

Callback URL. Must be a valid http(s) URL. Maximum 1024 characters (inclusive; 1024 accepted, 1025 rejected). Internal domains (.sendcloud.io / .sohuno.com / *.sendcloud.net), private IPv4 addresses, and port 22 are rejected with 40707 WEBHOOK_URL_TESTFAILED.

categoryName

string

required

Associated API_USER (required)

event

string

Event types (comma-separated valid event codes). If omitted, defaults to 1,3,4,5,10,11,12,18 (all valid codes except soft bounce 7, suppressed 81, hard bounce 83). 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

Where to Find WebHook Event Codes

200WebHook added successfully

400Business error. Note: server returns HTTP 200 with the business code in statusCode; the HTTP status here is a documentation placeholder. See error code table below for 40005 / 40704 / 40705 / 40706 / 40707 / 40708 / 40713 / 40714 / 40715 / 40717.