Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions devrev-snapin-template.plain
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
- Please note that EventContextIn and EventContextOut interfaces are deprecated.

- The External Domain Metadata is a JSON object that describes the logical domain model of an external system. It defines the types of external record types, the relationships between those record types, and the metadata associated with each field, including the field’s data type, human-readable name, and other descriptive attributes.
- Note: Resource "attachments" should not be included in The External Domain Metadata JSON object even if the external system supports attachments. This is handled automatically by The Airdrop SDK Library.
- Note: Resource "attachments" *MUST NOT* be included in The External Domain Metadata JSON object even if the external system supports attachments. This is handled automatically by The Airdrop SDK Library.

- The Initial Domain Mapping is a JSON object that defines how the logical domain model described by The External Domain Metadata maps to the target domain model in DevRev. It specifies the correspondence between each external record type and DevRev leaf type, as well as the mapping of individual fields, including transformation logic, value conversions, and any fixed or default values.
- Note: Resource "attachments" should not be included in The Initial Domain Mapping JSON object even if the external system supports attachments. This is handled automatically by The Airdrop SDK Library.
- Note: Resource "attachments" *MUST NOT* be included in The Initial Domain Mapping JSON object even if the external system supports attachments. This is handled automatically by The Airdrop SDK Library.

- The External Sync Unit Item Count is a numeric field representing the total number of items (such as cards) contained within a given external sync unit. It is accessible as "item_count" field of the external sync unit.

Expand Down
3 changes: 2 additions & 1 deletion docs/attachments-extraction.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import {

const getAttachmentStream = async ({
item,
event,
}: ExternalSystemAttachmentStreamingParams): Promise<ExternalSystemAttachmentStreamingResponse> => {
// IMPORTANT: "url" is not necessarily deployed on the base URL of The API. It could also be an external URL (e.g. https://example.com/attachment.pdf, https://devrev.ai, ...)
const { id, url } = item;
Expand All @@ -44,7 +45,7 @@ const getAttachmentStream = async ({
responseType: 'stream',
headers: {
'Accept-Encoding': 'identity',
'Authorization': ... // TODO: Authorization if needed
'Authorization': ... // TODO: Authorization if needed. Credentials should be read from event["payload"]["connection_data"]["key"]
},
});

Expand Down
Loading