ID (stringa)

Un identificativo univoco che identifica ciascun evento. source+id deve essere univoco. Il backend deve essere in grado di tracciare in modo univoco questo ID nei log e in altri record. Invia un ID univoco per ogni notifica di invio. Lo stesso ID può essere inviato in caso di mancato invio della notifica.

source+id è registrato nel servizio di registrazione IBM Cloud. Utilizzando questa combinazione, i clienti di IBM sono in grado di tracciare il movimento degli eventi da un sistema all'altro e di aiutare il debug e il tracciamento.

id: qwer-1234-1qsd-po94

ce-id: qwer-1234-1qsd-po94

origine (riferimento URI)

Questo è l'identificativo del produttore dell'evento. Un modo per identificare in modo univoco l'origine dell'evento. Per i servizi IBM Cloud si tratta del crn dell'istanza del servizio che produce gli eventi. Per le origini API può essere qualcosa con cui il backend del produttore dell'evento può identificarsi in modo univoco.

source: com.mybank.customerbanking.accountmanagement

ce-source: com.mybank.customerbanking.accountmanagement

specversion (stringa)

È la versione della specifica Cloud Events attualmente supportata da Event Notifications. Questo valore deve essere impostato su " 1.0 ".

specversion:1.0

ce-specversion:1.0

type (stringa)

Descrive il tipo di evento. È nel formato <event-type-name>:<sub-type>. Questo tipo è definito dal produttore.

Il nome del tipo di evento deve essere preceduto dai nomi DNS inversi in modo che il tipo di evento sia identificato in modo univoco. Lo stesso tipo di evento può essere prodotto da due origini diverse. Si consiglia di utilizzare il trattino - come separatore invece di _.

`type:com.acmebank.password:expiring-in-15-days`
Type: `com.acmebank.password`
Sub type: `expiring-in-15-days`

ce-type:com.acmebank.password:expiring-in-15-days`

`type:com.acmebank.password-changed`
Type: `com.acmebank.password-changed`
Sub type: N/A

`ce-type:com.acmebank.password-changed`

ora (timestamp)

Data / ora UTC in cui si è verificato l'evento. Deve essere nel formato RFC 3339.

time: 2022-02-10T10:51:37+00:00

ce-time: 2022-02-10T10:51:37+00:00

subject (stringa)

Questo è l'oggetto dell'evento nel produttore dell'evento (origine). Quindi, questo può essere l'ID account della password che sta per scadere.

subject:ajay@accts.acmebank.com`

`ce-subject:ajay@accts.acmebank.com`

tipo di dato

Definisce il tipo MIME del contenuto dei dati. Attualmente è supportato solo "application/json".

`datacontenttype: application/json`

`Content-Type:application/json`

dati

Il payload dell'evento. Può contenere informazioni che possono essere trasmesse a destinazioni come i webhook. Deve essere un oggetto JSON valido.

Non includere nel payload informazioni sensibili come password, chiavi API, numeri di identificazione personale, informazioni sulle carte di credito o altri dati riservati. Il carico utile può essere registrato, memorizzato o trasmesso a varie destinazioni.

data: { "lastchanged-days": "74", "reason":"time-based"}

ibmensourceid (stringa)

Questo è l'ID dell'origine creato in Event Notifications. È disponibile nell'IU Event Notifications nella sezione "Sources".

ibmensourceid: 121313123:api

ce-ibmensourceid: 121313123:api

ibmenseverity (Stringa)

Alcune origini possono avere il concetto di severità Evento. Quindi viene fornito un modo pratico per specificare una severità dell'evento.

ibmenseverity:LOW

`ce-ibmenseverity:LOW`

ibmendefaultshort (Stringa)

Questo messaggio viene utilizzato nel caso in cui l'evento instradato a una destinazione che richiede un testo leggibile, ma non è specificato un attributo specifico della destinazione.

Ad esempio, se ibmenfcmbody non è specificato e l'evento viene instradato alla destinazione di tipo FCM Android, ibmendefaultshort viene utilizzato come titolo di notifica (android_title).

ibmendefaultshort: "Change password"

ce-ibmendefaultshort: "Change password"

ibmendefaultlong (Stringa)

Questo messaggio viene utilizzato nel caso in cui l'evento instradato a una destinazione che richiede un testo leggibile, ma non è specificato un attributo specifico della destinazione.

Ad esempio, se ibmenfcmbody non è specificato e l'evento viene instradato alla destinazione di tipo FCM Android, ibmendefaultlong viene utilizzato come corpo della notifica (avviso).

ibmendefaultlong: "Password will expire in 10 Days. Please log in to the Bank home page and click on Change Password link to change your password."

ce-ibmendefaultlong: "Password will expire in 10 Days. Please log in to the Bank home page and click on Change Password link to change your password."

ibmenfcmbody (stringa/json)

Questo attributo è necessario se si vuole inviare una notifica push a un dispositivo Android. Questo è il corpo che si vuole inviare al server FCM; deve essere JSON in formato stringa. Per ulteriori informazioni sull'organismo FCM, vedere qui.

"ibmenfcmbody": "{\"message\":{\"android\":{\"ttl\":\"86400s\",\"notification\":{\"click_action\":\"OPEN_ACTIVITY_1\"},\"data\":{\"id\":\"test_id\"}}}}"

ce-ibmenfcmbody: {"message":{"android":{"ttl":"86400s","notification":{"click_action":"OPEN_ACTIVITY_1"},"data":{"id":"test_id"}}}}

ibmenapnsbody (stringa/json)

Questo attributo è necessario se si vuole inviare una notifica push a un dispositivo iOS. Questo è il corpo che si vuole inviare al server APN; deve essere JSON in formato stringa. Per ulteriori informazioni sul corpo degli APN, seguire questa documentazione qui.

"ibmenapnsbody": {"aps":{"alert":{"title":"Game Request","subtitle":"Five Card Draw","body":"Bob wants to play poker"},"category":"GAME_INVITATION"},"gameID":"12345678"}

ce-ibmenapnsbody: {"aps":{"alert":{"title":"Game Request","subtitle":"Five Card Draw","body":"Bob wants to play poker"},"category":"GAME_INVITATION"},"gameID":"12345678"}

ce-ibmenapnsbody: {"en_data":{"alert":"alert","url":"https","badge":9,"sound":"bingbong.aiff","payload":{"myaarray":["cc75e4a6-edd8-3bec-a7c3-dfca6572a03b"]},"type":"DEFAULT","subtitle":"dummy","title":"dummy1","body":"body","ios_action_key":"key","interactive_category":"interactiveCategory","title_loc_key":"titleLocKey","loc_key":"GAME_PLAY_REQUEST_FORMAT","launch_image":"image.png","title_loc_args":["Shelly","Rick"],"loc_args":["Shelly","Rick"],"attachment_url":"some url","apns_collapse_id":"12","apns_thread_id":"1","apns_group_summary_arg":"apnsGroupSummaryArg","apns_group_summary_arg_count":1}}

ibmenchromebody (stringa/json)

Questo attributo è necessario se si vuole inviare una notifica push a un dispositivo chrome. Questo è il corpo che si vuole inviare al server FCM; deve essere JSON in formato stringa. Per ulteriori informazioni sul corpo cromato, vedere Notifica.

Puoi seguire questi esempi per un rapido avvio:

"ibmenchromebody": "{\"title\":\"Hello Chrome\", \"options\": {}}"

Per personalizzare le tue notifiche di push chrome, puoi fornire intestazioni chrome. Alcuni di essi sono obbligatori per consegnare una notifica se la chiave è presente. Il corpo di esempio è il seguente:

"ibmenchromeheaders":"{\"TTL\":100}"

ce-ibmenchromebody: {"title":"Hello Chrome", "options": {}}

ce-ibmenchromeheaders: "{"TTL":100}"

ibmenfirefoxbody (stringa/json)

Questo attributo è necessario se si vuole inviare una notifica push a un dispositivo Firefox. Questo è il corpo che si vuole inviare al server Firefox Push; deve essere JSON in formato stringa. Per ulteriori informazioni sull'organismo Firefox, vedere Notifica.

Puoi seguire questi esempi per un rapido avvio:

"ibmenfirefoxbody": "{\"title\":\"Hello Firefox\", \"options\": {}}"

Per personalizzare le tue notifiche di push chrome, puoi fornire le intestazioni Firefox. Alcuni di essi sono obbligatori per consegnare una notifica se la chiave è presente. Il corpo di esempio è il seguente:

"ibmenfirefoxheaders": "{\"TTL\":100, \"Urgency\": \"low\" , \"Topic\": \"Test Firefox Notifications\"}",

ce-ibmenfirefoxbody: {"title":"Hello Firefox", "options": {}}

ce-ibmenfirefoxheaders: {"TTL":100, "Urgency": "low" , "Topic": "Test Firefox Notifications"}

ibmensafaribody (stringa/json)

Questo attributo è necessario se si vuole inviare una notifica push a un dispositivo Safari. Questo è il corpo che si vuole inviare a Apple Push Notification Server; deve essere JSON in formato stringa. Per ulteriori informazioni sul corpo di Safari, vedere Configurazione delle notifiche push di Safari.

Puoi seguire questi esempi per un rapido avvio:

"ibmensafaribody": "{\"aps\":{\"alert\":{\"title\":\"Shipment Order 1832128321 Delevered\",\"body\":\"Shipment Order 1832128321 Delevered.\",\"action\":\"View\"},\"url-args\":[\"1832128321\"]}}"

ce-ibmensafaribody: {"aps":{"alert":{"title":"Shipment Order 1832128321 Delevered","body":"Shipment Order 1832128321 Delevered.","action":"View"},"url-args":["1832128321"]}}

ibmenhuaweibody(string/json)

Questo attributo è necessario se si vuole inviare una notifica push a un dispositivo Huawei. Questo è il corpo che si vuole inviare al server Huawei Push Kit; deve essere JSON in formato stringa. Per ulteriori informazioni sul corpo di Huawei, vedere il payload di Huawei Push Notification.

È possibile seguire questi esempi per un avvio rapido:

"ibmenhuaweibody":"{\"message\":{\"android\":{\"notification\":{\"title\":\"New Message\",\"body\":\"Hello World\",\"click_action\":{\"type\":3}}}}}"

ce-ibmenhuaweibody: {"aps":{"alert":{"title":"Shipment Order 1832128321 Delevered","body":"Shipment Order 1832128321 Delevered.","action":"View"},"url-args":["1832128321"]}}

ibmenpushto (stringa/json)

Questo attributo è obbligatorio per la consegna a una destinazione Android, FCM, APNS o Huawei.

Contiene i dettagli della destinazione a cui si vuole inviare una notifica push. Questo campo è anche il formato stringa di JSON e contiene inoltre il seguente campo

• user_id- Userid da associare al dispositivo. in cui si vuole indirizzare la notifica
• tag- Questo viene utilizzato per inviare notifiche sulle tag registrate
• platform- È possibile utilizzare come destinazione tutti i dispositivi registrati per piattaforme.

Di seguito sono riportati i corrispondenti valori di piattaforma per ciascun tipo di destinazione.

• FCM: push_android
• APNS: push_ios
• Chrome: push_chrome
• Firefox: push_firefox
• Safari: push_safari
• Huawei: push_huawei
• fcm_devices- Identificativo univoco del dispositivo FCM a cui vuoi indirizzare la tua notifica
• apns_devices- Identificativo univoco del dispositivo APNS a cui vuoi indirizzare la tua notifica
• chrome_devices- Identificativo univoco del dispositivo Web Chrome in cui si desidera indirizzare la notifica
• firefox_devices- Identificativo univoco del dispositivo Web Firefox a cui si desidera indirizzare la notifica
• safari_devices- Identificativo univoco del dispositivo Web Safari in cui si desidera indirizzare la notifica
• huawei_devices- Identificatore univoco del dispositivo Huawei Web a cui si vuole indirizzare la notifica

"ibmenpushto": "{\"fcm_devices\": [\"9c75975a-37d0-3898-905d-3b5ee0d7c172\",\"C9CACDF5-6EBF-49E1-AD60-E25BA23E954C\"]}"`
"ibmenpushto": "{\"apns_devices\": [\"1c75972a-37d0-3898-905d-3b5ee0d7c172\",\"M9CACDF5-1EBF-49E1-AD60-E25BA23E954C\"]}"
"ibmenpushto": "{\"chrome_devices\": [\"2c75972a-37d0-3898-905d-3b5ee0d7c182\",\"N9CACDF5-1EBF-49E1-AD60-E25BA23E994D\"]}"
"ibmenpushto": "{\"firefox_devices\": [\"3c75972a-37d0-3898-905d-3b5ee0d7c182\",\"L9CACDF5-1EBF-49E1-AD60-E25BA23E994E\"]}"
"ibmenpushto": "{\"safari_devices\": [\"1175972a-37d0-3898-905d-3b5ee0d7c1D2\",\"Q9CACDF5-1EBF-49E1-AD60-E25BA23E994N\"]}"
"ibmenpushto": "{\"huawei_devices\": [\"1175972a-37d0-3898-905d-3b5ee0d7c1D2\",\"Q9CACDF5-1EBF-49E1-AD60-E25BA23E994N\"]}"

"ibmenpushto": "{\"fcm_devices\": [\"9c75975a-37d0-3898-905d-3b5ee0d7c172\",\"C9CACDF5-6EBF-49E1-AD60-E25BA23E954C\"],\"apns_devices\": [\"1c75972a-37d0-3898-905d-3b5ee0d7c172\",\"M9CACDF5-1EBF-49E1-AD60-E25BA23E954C\"],\"chrome_devices\": [\"2c75972a-37d0-3898-905d-3b5ee0d7c182\",\"N9CACDF5-1EBF-49E1-AD60-E25BA23E994D\"],\"firefox_devices\": [\"3c75972a-37d0-3898-905d-3b5ee0d7c182\",\"L9CACDF5-1EBF-49E1-AD60-E25BA23E994E\"],\"safari_devices\": [\"1175972a-37d0-3898-905d-3b5ee0d7c1D2\",\"Q9CACDF5-1EBF-49E1-AD60-E25BA23E994N\"]}"

"ibmenpushto": "{\"user_ids\": [\"ajay@accts.acmebank.com\",\"ankit@accts.acmebank.com\"]}"

"ibmenpushto": "{\"tags\": [\"salesTeam\",\"TechTeam\"]}"

"ibmenpushto": "{\"platforms\":[\"push_android\",\"push_ios\"]]}"

"ibmenpushto": "{\"platforms\":[\"push_android\"]}"
"ibmenpushto": "{\"platforms\":[\"push_ios\"]}"
"ibmenpushto": "{\"platforms\":[\"push_chrome\"]}"
"ibmenpushto": "{\"platforms\":[\"push_firefox\"]}"
"ibmenpushto": "{\"platforms\":[\"push_safari\"]}"
"ibmenpushto": "{\"platforms\":[\"push_huawei\"]}"

ce-ibmenpushto: "{\"user_id\": [\"ajay@accts.acmebank.com\",\"ankit@accts.acmebank.com\"]}"

allegati(array)

Questo attributo viene utilizzato per includere gli allegati dei file quando si inviano notifiche a destinazioni e-mail di dominio personalizzate. Ogni allegato nell'array deve includere il contenuto del file codificato nel formato Base64, insieme a metadati quali il nome del file, il tipo di contenuto e la disposizione.

Gli allegati e-mail sono supportati solo per le destinazioni e-mail con dominio personalizzato. Questa funzione non è disponibile per le destinazioni e-mail predefinite di IBM Cloud.

L'array attachments contiene oggetti con le seguenti proprietà:

contenuto (stringa, obbligatorio)

Il contenuto del file è codificato nel formato base64.

Assicurarsi che il contenuto sia codificato correttamente prima di includerlo nel payload.

nome del file (stringa, obbligatorio)

Il nome del file come apparirà al destinatario. Includere l'estensione del file (ad esempio, " document.pdf ", " report.xlsx ").

content_type (stringa, non obbligatorio)

Il tipo MIME del file. Esempi comuni sono:

• application/pdf per i file PDF

disposizione (stringa, obbligatorio)

Utilizzare attachment per indicare che il file è un allegato.

"attachments": [
  {
    "content": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL...",
    "filename": "document.pdf",
    "content_type": "application/pdf",
    "disposition": "attachment"
  },
  {
    "content": "UEsDBBQAAAAIAKt8elYAAAAAAAAAAAAAAAAJAAAA...",
    "filename": "report.xlsx",
    "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
    "disposition": "attachment"
  }
]

ce-attachments: [{"content":"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL...","filename":"document.pdf","content_type":"application/pdf","disposition":"attachment"}]