Download OpenAPI specification:Download
Content Watcher Service API
blockNumber
| blockNumber | number [ 0 .. 4294967296 ] The block number to reset the scanner to |
| rewindOffset | number [ 0 .. 4294967296 ] Number of blocks to rewind the scanner to (from |
| immediate | boolean Whether to schedule the new scan immediately or wait for the next scheduled interval |
{- "blockNumber": 0,
- "rewindOffset": 100,
- "immediate": true
}watchOptions: Filter contents by schemaIds and/or msaIds
| schemaIds | Array of numbers [ 0 .. 65536 ] Specific schema ids to watch for |
| dsnpIds | Array of strings Specific dsnpIds (msa_id) to watch for |
{- "schemaIds": [
- 1,
- 19
], - "dsnpIds": [
- "10074",
- "100001"
]
}Search for DSNP content by id, startBlock, endBlock, and filters
| clientReferenceId | string An optional client-supplied reference ID by which it can identify the result of this search |
| startBlock | number [ 0 .. 4294967296 ] The block number to search (backward) from |
| blockCount required | number [ 0 .. 4294967296 ] The number of blocks to scan (backwards) |
object The schemaIds/dsnpIds to filter by | |
| webhookUrl required | string A webhook URL to be notified of the results of this search |
{- "clientReferenceId": "string",
- "startBlock": 100,
- "blockCount": 101,
- "filters": {
- "schemaIds": [
- 1,
- 19
], - "dsnpIds": [
- "10074",
- "100001"
]
},
}"string"Register a webhook to be called when a new content is encountered
| url required | string Webhook URL |
| announcementTypes required | Array of strings (AnnouncementTypeName) Items Enum: "tombstone" "broadcast" "reply" "reaction" "profile" "update" |
{- "announcementTypes": [
- "broadcast",
- "reaction",
- "tombstone",
- "reply",
- "update"
]
}[- {
- "announcementTypes": [
- "broadcast",
- "reaction",
- "tombstone",
- "reply",
- "update"
]
}
]