Creates an app integration push notification

Create a new app integration push notification.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

The request data transfer object for the push notification integration when creating.

appIntegrationIdstring · min: 1Required

The app integration provider ID of the push notification.

codestring · min: 1Required

The code of the push notification.

namestring · min: 1Required

The name of the push notification.

projectIdstring · min: 1Required

The project ID of the push notification.

clientEmailstring · min: 1Required

The client email of the push notification.

clientIdstring · nullableOptional

The client ID of the push notification.

privateKeystring · min: 1Required

The private key of the push notification.

authURLstring · uri · nullableOptional

The authentication URL of the push notification.

tokenURLstring · uri · nullableOptional

The token URL of the push notification.

authProviderX509CertURLstring · uri · nullableOptional

The authentication provider X509 certificate URL of the push notification.

clientX509CertURLstring · uri · nullableOptional

The client X509 certificate URL of the push notification.

universeDomainstring · nullableOptional

The universe domain of the push notification.

apiKeystring · nullableOptional

The API key of the push notification.

authDomainstring · nullableOptional

The authentication domain of the push notification.

storageBucketstring · nullableOptional

The storage bucket of the push notification.

messagingSenderIdstring · nullableOptional

The messaging sender ID of the push notification.

appIdstring · nullableOptional

The app ID of the push notification. Use projectId instead if using Firebase service.

measurementIdstring · nullableOptional

The measurement ID of the push notification.

vapidKeystring · nullableOptional

The VAPID key of the push notification.

isDefaultbooleanOptional

Flag to indicate if the push notification integration is the default. Default is false.

Responses

201

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/app-integrations/push-notification

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/push-notification HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 998

{
  "appIntegrationId": "sApKpllz4sAplsmzha",
  "code": "FIREBASE_PUSH",
  "name": "Firebase Push Notification",
  "projectId": "firebase-project-123",
  "clientEmail": "[e-mail]",
  "clientId": "1234567890",
  "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASC...\n-----END PRIVATE KEY-----\n",
  "authURL": "https://accounts.google.com/o/oauth2/auth",
  "tokenURL": "https://oauth2.googleapis.com/token",
  "authProviderX509CertURL": "https://www.googleapis.com/oauth2/v1/certs",
  "clientX509CertURL": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk%40firebase-project-123.iam.gserviceaccount.com",
  "universeDomain": "firebaseapp.com",
  "apiKey": "AIzaSyD-EXAMPLE-KEY-1234567890",
  "authDomain": "firebase-project-123.firebaseapp.com",
  "storageBucket": "firebase-project-123.appspot.com",
  "messagingSenderId": "1234567890",
  "appId": "1:1234567890:web:abcdef123456",
  "measurementId": "G-EXAMPLEID",
  "vapidKey": "BEXAMPLEVAPIDKEY1234567890",
  "isDefault": true
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "appIntegration": {
      "type": "PaymentGateway",
      "name": "Stripe",
      "domain": "https://stripe.com",
      "description": "Stripe payment gateway",
      "logoURL": null,
      "status": "Active",
      "id": "sApKpllz4sAplsmzha"
    },
    "status": "Active",
    "isDefault": false,
    "vapidKey": "vapid-key",
    "measurementId": "measurement-id",
    "appId": "app-id",
    "messagingSenderId": "messaging-sender-id",
    "storageBucket": "storage-bucket",
    "authDomain": "auth-domain",
    "apiKey": "api-key",
    "id": "sApKpllz4sAplsmzha",
    "universeDomain": "universe-domain",
    "authProviderX509CertURL": "auth-provider-x509-cert-url",
    "tokenURL": "token-url",
    "authURL": "auth-url",
    "privateKey": "private-key",
    "clientId": "client-id",
    "clientEmail": "client-email",
    "projectId": "project-id",
    "name": "name",
    "code": "code",
    "clientX509CertURL": "client-x509-cert-url"
  },
  "errors": []
}