Download OpenAPI specification:
Content Watcher Service API
| 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
}| schemaIds | Array of numbers non-empty unique Specific schema ids to watch for |
| dsnpIds | Array of strings non-empty unique Specific dsnpIds (msa_id) to watch for |
{- "schemaIds": [
- 1,
- 19
], - "dsnpIds": [
- "10074",
- "100001"
]
}| clientReferenceId | string An optional client-supplied reference ID by which it can identify the result of this search |
| upperBoundBlock | number [ 0 .. 4294967296 ] The highest block number to start the backward search from |
| blockCount required | number [ 0 .. 4294967296 ] The number of blocks to scan (backwards) |
object The schemaIds/dsnpIds to filter by | |
| webhookUrl required | string <uri> A webhook URL to be notified of the results of this search |
{- "clientReferenceId": "string",
- "upperBoundBlock": 100,
- "blockCount": 101,
- "filters": {
- "schemaIds": [
- 1,
- 19
], - "dsnpIds": [
- "10074",
- "100001"
]
},
}{- "status": 200,
- "jobId": "7b02edd742a653a3cf63bb0c84e43d3678aa045f"
}| announcementTypes required | Array of strings (AnnouncementTypeName) non-empty Items Enum: "tombstone" "broadcast" "reply" "reaction" "profile" "update" Announcement types to send to the webhook |
| url required | string <uri> Webhook URL |
{- "announcementTypes": [
- "broadcast",
- "reaction",
- "tombstone",
- "reply",
- "update"
],
}{- "status": 200,
- "registeredWebhooks": [
- {
- "announcementTypes": [
- "broadcast",
- "reaction",
- "tombstone",
- "reply",
- "update"
],
}
]
}