Data Integration

The Canvas SDK allows you to manage documents in the Data Integration queue.

Marking a Document as Junk #

To mark a document in the Data Integration queue as junk (spam), import the JunkDocument class and create an instance of it.

Attribute TypeDescription
document_idrequiredstringThe ID of the IntegrationTask document to mark as junk

An example of marking a document as junk:

from canvas_sdk.effects import Effect
from canvas_sdk.effects.data_integration import JunkDocument
from canvas_sdk.events import EventType
from canvas_sdk.handlers import BaseHandler


class JunkDocumentHandler(BaseHandler):
    RESPONDS_TO = EventType.Name(EventType.DOCUMENT_RECEIVED)

    def compute(self) -> list[Effect]:
        document_id = self.event.target.id

        junk_document = JunkDocument(
            document_id=document_id,
        )

        return [junk_document.apply()]