Graph Service Webhooks API (1.0.0)

Download OpenAPI specification:Download

Announce a graph update

Request Body schema: application/json
required
msaId
required
string

MSA Id for which this notification is being sent

schemaId
required
number

Schema ID of graph that was updated

pageId
required
number

Page ID of graph page that was updated/deleted

prevContentHash
required
number

integer representation of the content hash of the updated page's previous state

currContentHash
number

integer representation of the content hash of the updated pages new state

updateType
required
any (updateType)
Enum: "GraphPageUpdated" "GraphPageDeleted"

Responses

Request samples

Content type
application/json
{
  • "msaId": "2",
  • "schemaId": 8,
  • "pageId": 15,
  • "prevContentHash": 123456,
  • "currContentHash": 0,
  • "updateType": "GraphPageUpdated"
}

Send the status of a requested graph update

Request Body schema: application/json
required
referenceId
required
string

Job reference ID of a previously submitted graph update request

status
required
string (status)
Enum: "pending" "expired" "failed" "succeeded"

Responses

Request samples

Content type
application/json
{
  • "referenceId": "Lve95gjOVATpfV8EL5X4nxwjKHE",
  • "status": "pending"
}