Content Watcher Service

Webhooks Reference

Open Full API Reference Page

Path Table

Reference Table

Path Details

[POST]/content-announcements

• Summary
  Notify a webhook client of a content announcement found on the blockchain

• Operation id
  createAnnouncementResponse

RequestBody

• application/json

{
  // An optional identifier for the request, may be used for tracking or correlation
  requestId?: string
  // An optional webhook URL registered as part of a specific search request
  webhookUrl?: string
  // Identifier for the schema being used or referenced
  schemaId: integer
  // The block number on the blockchain where this announcement was recorded
  blockNumber: integer
  announcement: #/components/schemas/TombstoneAnnouncement | #/components/schemas/BroadcastAnnouncement | #/components/schemas/ReplyAnnouncement | #/components/schemas/ReactionAnnouncement | #/components/schemas/ProfileAnnouncement | #/components/schemas/UpdateAnnouncement
}

Responses

• 201 Content announcement notification received

• 400 Bad request

References

#/components/schemas/AnnouncementType

#/components/schemas/AnnouncementResponse

{
  // An optional identifier for the request, may be used for tracking or correlation
  requestId?: string
  // An optional webhook URL registered as part of a specific search request
  webhookUrl?: string
  // Identifier for the schema being used or referenced
  schemaId: integer
  // The block number on the blockchain where this announcement was recorded
  blockNumber: integer
  announcement: #/components/schemas/TombstoneAnnouncement | #/components/schemas/BroadcastAnnouncement | #/components/schemas/ReplyAnnouncement | #/components/schemas/ReactionAnnouncement | #/components/schemas/ProfileAnnouncement | #/components/schemas/UpdateAnnouncement
}

#/components/schemas/TypedAnnouncement

{
  fromId: string
}

#/components/schemas/TombstoneAnnouncement

undefined?: #/components/schemas/TypedAnnouncement & {
   announcementType?: enum[0]
   targetAnnouncementType: integer
   targetContentHash: string
 }

#/components/schemas/BroadcastAnnouncement

undefined?: #/components/schemas/TypedAnnouncement & {
   announcementType?: enum[2]
   contentHash: string
   url: string
 }

#/components/schemas/ReplyAnnouncement

undefined?: #/components/schemas/TypedAnnouncement & {
   announcementType?: enum[3]
   contentHash: string
   inReplyTo: string
   url: string
 }

#/components/schemas/ReactionAnnouncement

undefined?: #/components/schemas/TypedAnnouncement & {
   announcementType?: enum[4]
   emoji: string
   inReplyTo: string
   apply: integer
 }

#/components/schemas/ProfileAnnouncement

undefined?: #/components/schemas/TypedAnnouncement & {
   announcementType?: enum[5]
   contentHash: string
   url: string
 }

#/components/schemas/UpdateAnnouncement

undefined?: #/components/schemas/TypedAnnouncement & {
   announcementType?: enum[6]
   contentHash: string
   targetAnnouncementType: integer
   targetContentHash: string
   url: string
 }