webhooks

Create a web hook

Requires the WEBHOOK.CREATE permission.

post/v{version}/webhooks

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/webhooks
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
usernamestring nullable

The username used for basic authentication.

passwordstring nullable

The password used for basic authentication.

api_header_fieldstring nullable

The name of the header field for authentication with an API key.

api_keystring nullable

The value of for authentication with an API key.

urlstring nullable required

The url of the webhook where webhooks will be sent.

included_actionsstring[] nullable

The actions of which a webhook will be sent.

excluded_actionsstring[] nullable

The actions of which a webhook will not be sent.

activeboolean

The status of the webhook.

penalty_boxstring nullable
secret_keystring nullable
signing_protocolstring nullable

The signing protocol for the webhook.

previous_secret_keystring nullable
previous_signing_protocolstring nullable
secret_rolled_atstring nullable

The instant when the secret was rolled.

include_previous_databoolean

Define whether the webhook payload include the previous status or only the current status

authentication_type'PASSWORD' | 'API_KEY' | 'NONE'

The type of authentication used for the webhook.

disabled_reasonstring nullable

The reason the webhook was automatically disabled, if applicable.

namestring nullable required
referencestring nullable required

Response

Created

object_typestring nullable
idstring nullable
usernamestring nullable

The username used for basic authentication.

passwordstring nullable

The password used for basic authentication.

api_header_fieldstring nullable

The name of the header field for authentication with an API key.

api_keystring nullable

The value of for authentication with an API key.

urlstring nullable

The url of the webhook where webhooks will be sent.

included_actionsstring[] nullable

The actions of which a webhook will be sent.

excluded_actionsstring[] nullable

The actions of which a webhook will not be sent.

activeboolean

The status of the webhook.

penalty_boxstring nullable
secret_keystring nullable
signing_protocolstring nullable

The signing protocol for the webhook.

previous_secret_keystring nullable
previous_signing_protocolstring nullable
secret_rolled_atstring nullable

The instant when the secret was rolled.

include_previous_databoolean

Define whether the webhook payload include the previous status or only the current status

authentication_type'PASSWORD' | 'API_KEY' | 'NONE'

The type of authentication used for the webhook.

disabled_reasonstring nullable

The reason the webhook was automatically disabled, if applicable.

namestring nullable
referencestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.