Documentation

Creates a webhook for the given merchant.

post
https://api-sandbox.nofrixion.com/api/v1/webhooks

Authorization: End user token is required.

User permissions required: CanCreateWebhooks

Body Params

The WebHookRequest to be created.

uuid
uuid
required
resourceTypes
array of strings | null

The resource types that the webhook should be generated for.

resourceTypes
string | null

The destination URL for the webhook. Required for webhook notifications.

boolean
string | null

The secret key required to authenticate webhook notifications. Required for webhook notifications.

boolean
string | null

The recipient email address(es) for notifications. Multiple addresses can be separated by a comma, semicolon, or space. Reruired for email notifications.

string | null

The email address to which notifications about failed webhook deliveries will be sent.

string
enum
required

Determines the delivery method for the notification. The default is Webhook.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

201

The created webhook is returned.

Callbacks

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 9 months ago