Wenn ein Webhook registriert ist, gibt Kaizala eine WebHookantwort für jedes Ereignis auf der registrierten objectId zurück, gefiltert nach registrierten Ereignissen.
Im Folgenden finden Sie Schemadetails für verschiedene Webhookantworten für verschiedene Ereignisse.
Antworttext
Parameter
Typ
Beschreibung
objectId
Zeichenfolge
Bezeichner, der das Objekt darstellt, in dem der Webhook erstellt wurde. Für ObjectType=Group, den Bezeichner der Gruppe, für ObjectType=Action, seine actionId, für ObjectType=ActionPackage, seine action-package-id
objectType
Zeichenfolge
Enumeration: "Group"/"Action"/"ActionPackage"
eventType
Zeichenfolge
Registriertes Ereignis, das aufgerufen wurde
Eventid
Zeichenfolge
Bezeichner, der das Ereignis darstellt
data
JSON-Objekt
Objekt, das datenspezifisch für dieses Ereignis darstellt. Unten definierte Parameter für jedes unterstützte Ereignis.
context
Zeichenfolge
Gibt einen Wert zurück, der beim Registrieren eines Webhooks unter dem Parameter "callbackContext" festgelegt wurde.
fromUser
Zeichenfolge
Telefonnummer des Absenders
fromUserId
Zeichenfolge
UserId des Absenders
fromUserName
Zeichenfolge
Registrierter Name des Absenders bei Kaizala
fromUserProfilePic
url
Profilbild des Absenders
Der Parameter "data" variiert je nach webHook-Ereignis. Sie finden das Schema für jedes Ereignis unten.
Daten für das Ereignis "TextMessageCreated"
Parameter
Typ
Beschreibung
text
Zeichenfolge
Gesendete SMS
WebHook-Beispielantwort für "TextMessageCreated"
{
"objectId": "8c2050-9be8-45d6-97f5-bb7013930027",
"objectType": "Group",
"eventType": "TextMessageCreated",
"eventId": "55ed01-02b5-491e-8e7e-484726da976b",
"data": {
"text": "Test Message"
},
"context": "Any data which is required to be returned in callback",
"fromUser": "+91xxxxxxxx",
"fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
"fromUserName": "Robin Richard",
"fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}
Daten für das Ereignis "AttachmentCreated"
Parameter
Typ
Beschreibung
media
Array
Jedes Element enthält mediaUrl und mediaFileName.
mediaUrl
url
URL des Bilds
mediaFileName
Zeichenfolge
Filename
actionType
Zeichenfolge
Enumerationswert : 'Image'
Beschriftung
Zeichenfolge
Mit dem Bild angefügte Beschriftung
WebHook-Beispielantwort für "AttachmentCreated"
{
"objectId": "8c291050-9be8-45d6-97f5-bb7013930027",
"objectType": "Group",
"eventType": "AttachmentCreated",
"eventId": "59e2e9f9-9b10-4b67-8bc5-3f85a04f2d91",
"data": {
"media": [
{
"mediaUrl": "https://cdn.inc-000.kms.osi.office.net/att/0ad142c52b30d797addebadb620c19bf6f018299ed4acdce5760e45e2e4bc4ae.jpg?sv=2015-12-11&sr=b&sig=Thbp46wdgoqbDaAF06v2Y2ijzny0jx2fBDo1EZab%2BNY%3D&st=2018-03-22T10:22:21Z&se=2292-01-05T11:22:21Z&sp=r",
"mediaFileName": "IMG_18-03-22_165220084_1.jpg"
}
],
"actionType": "Image",
"caption": "Testing."
},
"context": "Any data which is required to be returned in callback",
"fromUser": "+91xxxxxxxx",
"fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
"fromUserName": "Robin Richard",
"fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}
Daten für das Ereignis "Ankündigung"
Parameter
Typ
Beschreibung
title
String
Titel der Ankündigungsaktion
text
Zeichenfolge
Nachrichtentext der Ankündigungsaktion
media
Array
Jedes Element enthält mediaUrl und mediaFileName.
mediaUrl
url
URL des Bilds
mediaFileName
Zeichenfolge
Filename
WebHook-Beispielantwort für "Ankündigung"
{
"objectId": "8c291050-9be8-45d6-97f5-bb7013930027",
"objectType": "Group",
"eventType": "Announcement",
"eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
"data": {
"text": "Caption :Testing.",
"title": "Sent by Robin Richard",
"media": [
{
"url": "https://cdn.inc-000.kms.osi.office.net/contenthost/beb2cfef8732c6cc3b54652c1f6f99d64f529fd9be3d409e2966552639fb791f.jpeg",
"fileName": "e3c145f1-5e6f-4ee9-bd83-49ec3a1c2550.jpeg"
}
]
},
"context": "Any data which is required to be returned in callback",
"fromUser": "+91xxxxxxxx",
"fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
"fromUserName": "Robin Richard",
"fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}
Daten für das Ereignis "JobCreated"
Parameter
Typ
Beschreibung
title
String
Titel der Ankündigungsaktion
text
Zeichenfolge
Nachrichtentext der Ankündigungsaktion
actionId
Id
Bezeichner für diese bestimmte Instanz der Auftragsaktion
Duedate
Datum
Datum, bis zu dem der Auftrag abläuft
assignedTo
Zeichenfolgenarray
Array von Telefonnummern
WebHook-Beispielantwort für "JobCreated"
{
"objectId": "8c2950-9be8-45d6-97f5-bb7013930027",
"objectType": "Group",
"eventType": "JobCreated",
"eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
"data": {
"assignedTo": [
"+919740797266"
],
"title": "Test Job",
"dueDate": "2018-03-22T18:29:59Z",
"actionId": "aeb012-31a0-477a-a131-8a1e2791b36e",
"groupId": "8c291050-9be8-6-97f5-bb7013930027"
},
"context": "Any data which is required to be returned in callback",
"fromUser": "+91xxxxxxxx",
"fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
"fromUserName": "Robin Richard",
"fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}
Daten für das Ereignis "JobResponse"
Parameter
Typ
Beschreibung
title
String
Titel der Ankündigungsaktion
text
Zeichenfolge
Nachrichtentext der Ankündigungsaktion
actionId
Id
Bezeichner für diese bestimmte Instanz der Auftragsaktion
groupId
Zeichenfolge
Gruppenbezeichner
responseId
Zeichenfolge
GUID zum Identifizieren dieser Antwort
responseDetails
Zeichenfolgenarray
Array von Antwortobjekten
Zessionar
Zeichenfolge
Telefonnummer des Zugewiesenen
assigneeName
Zeichenfolge
Name des Zugewiesenen
assigneeProfilePic
url
URL des Profilbilds des Zugewiesenen
Iscompleted
Boolesch
Ist der Auftrag abgeschlossen?
WebHook-Beispielantwort für "JobResponse"
{
"objectId": "8c2950-9be8-45d6-97f5-bb7013930027",
"objectType": "Group",
"eventType": "JobResponse",
"eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
"data": {
"actionId": "2ce34820-3d67-4807-9a1d-7cf099c2e7ae",
"groupId": "8c291050-9be8-45d6-97f5-bb7013930027",
"responseId": "80a883ec-e6c7-4dc8-979d-d268bbeeee8b",
"responseDetails": {
"response": {
"assignee": "++91xxxxxxxx",
"assigneeName": "Robin Richard",
"assigneeProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-f391-4e7b-84eb-4e228406fb9b/c34afc0d536285d08e6409e416.jpg",
"isCompleted": true
}
}
},
"context": "Any data which is required to be returned in callback",
"fromUser": "+91xxxxxxxx",
"fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
"fromUserName": "Robin Richard",
"fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}
Daten für das Ereignis "ActionCreated" / "SurveyCreated"
Parameter
Typ
Beschreibung
actionId
Id
Bezeichner für diese bestimmte Instanz der Auftragsaktion
groupId
Zeichenfolge
Gruppenbezeichner
responseId
Zeichenfolge
GUID zum Identifizieren dieser Antwort
Fragen
Zeichenfolgenarray
Array von Objekten
Responder
Zeichenfolge
Telefonnummer des Antwortenden
responderName
Zeichenfolge
Name des Antwortenden
responderProfilePic
url
URL des Profilbilds des Antwortenden
isAnonymous
Boolesch
Wurde die Umfrageantwort anonym übermittelt?
isUpdateResponse
Boolesch
Wurde die Antwort vom Antwortgeber aktualisiert, da die Antwort zuvor übermittelt wurde?
Schemadetails für das "responseWithQuestions"-Objekt
Parameter
Typ
Beschreibung
title
String
Fragetitel
type
Zeichenfolge
QuestionType
options
Array
Liste der Optionen (Schlüssel-Wert-Paar), die für Multi-Choice-Fragen gelten
isInvisible
Boolesch
Ist die Frage auf der Benutzeroberfläche ausgeblendet?
WebHook-Beispielantwort für "ActionCreated" / "SurveyCreated"
Daten für das Ereignis "MemberAdded" / "MemberRemoved"
Parameter
Typ
Beschreibung
member
Zeichenfolge
Telefonnummer des hinzugefügten Mitglieds
Membername
Zeichenfolge
Name des hinzugefügten Members
type
Zeichenfolge
Mitgliedschaftsrolle des hinzugefügten Mitglieds
memberProfilePic
url
URL des Profilbilds des Zugewiesenen
WebHook-Beispielantwort für "MemberAdded" /'MemberRemoved'
{
"objectId": "8c2950-9be8-45d6-97f5-bb7013930027",
"objectType": "Group",
"eventType": "JobResponse",
"eventId": "3e49b367-acf6-48a7-a675-6bf4d372a070",
"data": {
"member": "+91xxxxxxxx",
"memberName": "Jan Decker",
"memberProfilePic": "https://mobileonlyapps.blob.core.windows.net/polymer-7ebb8d90e1324b5cbd61d1e10a30ada7/bbac582a4364860679d40fda7c6b.jpg",
"type": "Member"
},
"context": "Any data which is required to be returned in callback",
"fromUser": "+91xxxxxxxx",
"fromUserId": "72e91-f3-4e7b-84eb-4e228406fb9b",
"fromUserName": "Robin Richard",
"fromUserProfilePic": "https://mobileonlyapps.blob.core.windows.net/72e29591-4e7b-84eb-4e228406fb9b/c34afc0d53614ae29285d08e6409e416.jpg"
}
Feedback
War diese Seite hilfreich?
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.