Skip to navigation
Virtuous RaiseWebhook

Create a new webhook.

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Request

The webhook request model.
namestring or nullOptional
Gets or sets the name.
eventTypesListlist of enums or nullOptional
Gets or sets the event types list.
notificationUrlstring or nullOptionalformat: "uri"
statusenumOptional
Gets or sets the status.
Allowed values:
formatenumOptional
Gets or sets the format.
Allowed values:
securityTokenstring or nullOptional
Gets or sets the security token.

Response

OK
createdDatestring or nullOptionalRead-only
Gets or sets the created date.
eventTypesstring or nullOptionalRead-only
Gets or sets the event types.
eventTypesListlist of enums or nullOptional
Gets or sets the event types list.
formatenumOptional
Gets or sets the format.
Allowed values:
formatDisplaystring or nullOptional
Gets or sets the format display.
idlongOptional
Gets or sets the identifier.
modifiedDatestring or nullOptionalRead-only
Gets or sets the modified date.
namestring or nullOptionalRead-only
Gets or sets the name.
notificationUrlstring or nullOptionalRead-only
Gets or sets the notification URL.
securityTokenstring or nullOptionalRead-only
Gets or sets the security token.
statusenumOptional
Gets or sets the status.
Allowed values:
statusDisplaystring or nullOptional
Gets or sets the status display.

Errors

400
Bad Request Error