Glue API: Add push notification providers

Last updated:
Edit on GitHub

This endpoint lets you add push notification providers to further subscribe to notifications.

Installation

Install the Push Notification feature

Retrieve push notification providers

POST {{backend_url}}/push-notification-providers

PATH DESCRIPTION
{{backend_url}} URL of your Backend Glue API.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: POST https://glue-backend.de.b2c.demo-spryker.com/push-notification-providers

{
  "data": {
    "type": "push-notificatoin-providers",
    "attributes": {
      "name": "Fulfillment App provider"
    }
  }
}
ATTRIBUTE TYPE REQUIRED DESCRIPTION
name Boolean ✓ This name is used when subscribing to notifications.

Response

Response sample:

{
    "data": {
        "type": "push-notification-providers",
        "id": "ffb5875e-00d3-5436-ae67-08b7c9837f3e",
        "attributes": {
            "uuid": "ffb5875e-00d3-5436-ae67-08b7c9837f3e",
            "name": "Fulfillment App provider"
        },
        "links": {
            "self": "https://glue-backend.de.b2c.demo-spryker.com/push-notification-providers/ffb5875e-00d3-5436-ae67-08b7c9837f3e"
        }
    }
}
RESOURCE ATTRIBUTE TYPE DESCRIPTION
push-notification-providers uuid String Unique identifier of the provider. It’s used to retrieve or update a provider.
push-notification-providers name String This name is used when subscribing to notifications.

Possible errors

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.