Graph Service

Webhooks Reference

Open Full API Reference Page

Reference Table

Path Details

[POST]graph-update

• Summary
  Announce a graph update

• Operation id
  announceGraphUpdateV1

RequestBody

• application/json

{
  // MSA Id for which this notification is being sent
  msaId: string
  // Schema ID of graph that was updated
  schemaId: number
  // Page ID of graph page that was updated/deleted
  pageId: number
  // integer representation of the content hash of the updated page's previous state
  prevContentHash: number
  // integer representation of the content hash of the updated pages new state
  currContentHash?: number
}

Responses

• 200 Graph update announcement handled

• 400 Bad request

[POST]graph-request-status

• Summary
  Send the status of a requested graph update

• Operation id
  updateOperationStatusV1

RequestBody

• application/json

{
  // Job reference ID of a previously submitted graph update request
  referenceId: string
  status: enum[pending, expired, failed, succeeded]
}

Responses

• 200 Graph operation status received

• 400 Bad request

References

#/components/schemas/GraphChangeNotificationV1

{
  // MSA Id for which this notification is being sent
  msaId: string
  // Schema ID of graph that was updated
  schemaId: number
  // Page ID of graph page that was updated/deleted
  pageId: number
  // integer representation of the content hash of the updated page's previous state
  prevContentHash: number
  // integer representation of the content hash of the updated pages new state
  currContentHash?: number
}

#/components/schemas/GraphOperationStatusV1

{
  // Job reference ID of a previously submitted graph update request
  referenceId: string
  status: enum[pending, expired, failed, succeeded]
}