Update WebHook

post

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

Modify the configuration of an existing WebHook. Provide the current url + categoryName + event to match the target WebHook group, and at least one of newUrl / newCategoryName / newEvent to apply. Only callback URL, event types, and the associated API_USER can be changed.

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?://.*

Current callback URL (exact match, used with categoryName + event to locate the WebHook group to update). Must be a valid complete http(s) URL; maximum 1024 characters (inclusive; 1024 accepted, 1025 rejected).

categoryName

string

required

Current associated API_USER, or the special value all (matches category -1; required for matching).

event

string

required

Current event types of the WebHook group (comma-separated valid codes; used with url + categoryName for matching). Valid codes: 1, 3, 4, 5, 7, 10, 11, 12, 18, 81, 83. Same format rules as add-webhook: a leading comma or empty token 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.

newCategoryName

string

New associated API_USER (required if updating the API_USER). Must be an existing API_USER or the special value all.

newUrl

string

length ≤ 1024

^https?://.*

New callback URL (required if updating the URL). Same format/length rules as url. Must not already exist for the target API_USER, otherwise WEBHOOK_URL_EXIST (40708) is returned.

newEvent

string

New event types to apply (required if updating events). Same valid codes and format rules as event.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Where to Find WebHook Event Codes

200WebHook updated successfully. Returns the updated WebHook group under info.webhooks.

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 / 40706 / 40708 / 40712 / 40715 / 40716 / 40717.