Create notification rules

Request

POST https://api.nexway.store/customer-notifier/rules

Request body

The request body takes a complete Rules resource, containing the following writable properties:

{
    "customerId": "string",
    "rules": [
        {
            "emailChannel": {
                "recipients": [
                    "string"
                ]
            },
            "eventType": "string",
            "isActive": "boolean",
            "resource": "string",
            "webHooks": {
                "urlList": [
                    {
                        "Host": "string",
                        "Path": "string",
                        "Scheme": "string"
                    }
                ]
            }
        }
    ]
}

Properties

Name Type Description Additional
customerId string

Id of the customer

rules[] array

List

rules[].emailChannel object Optional
rules[].emailChannel.recipients[] array of string

List of emails to send notifications

Optional
rules[].eventType string

Event to be notified

Possible values are:

  • created
  • paymentInProgress
  • confirmed
  • fraudInProgress
  • subscriptionInProgress
  • fulfillmentInProgress
  • completed
  • partialCompleted
  • cancelled
  • partialCancelled
  • invoiceCreated
  • invoiceFailed
  • emailConfirmationSent
rules[].isActive boolean

Set of rules activated or not

Optional
rules[].resource string

Resource to be notified

Possible values are:

  • Order
  • Subscription
rules[].webHooks object Optional
rules[].webHooks.urlList[] array

List of urls to send notifications

Optional
rules[].webHooks.urlList[].Host string

Hostname of the url

Optional
rules[].webHooks.urlList[].Path string

Path of the url or uri

Optional
rules[].webHooks.urlList[].Scheme string

Scheme of the url

Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Success

success
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

409 Conflict

Conflict

500 Internal Server Error

Failure

503 Service Unavailable

Service Unavailable


Explore this API

rule request

this structure convey informations about rules of a customer

Request Content-Type
Response Content-Type
Try it out!