Create a notification

How to create a notification via API

To create a new notification, send a POST request to the /api/notifications endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/notifications

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.flash	boolean	Optional, default is 'false'
attributes.body	object	Optional, default to {}
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.notifiable	object	Required

Example

Request

The following request creates a new notification:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/notifications' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "notifications",
    "attributes": {
      "name": "DDT transport document"
    },
    "relationships": {
      "notifiable": {
        "data": {
          "type": "shipping_methods",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "notifications",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/notifications/xYZkjABcde"
    },
    "attributes": {
      "name": "DDT transport document",
      "flash": false,
      "body": {
        "sku": "REDHANDBAG",
        "name": "Enjoy your free item"
      },
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "notifiable": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/notifications/xYZkjABcde/relationships/notifiable",
          "related": "https://yourdomain.commercelayer.io/api/notifications/xYZkjABcde/notifiable"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}