Read post-delivery check-in setup references
Requires organization-wide access. Returns the saved resource IDs and revision for a setup the caller can read.
GET
Requires organization-wide access. Returns the saved resource IDs and revision for a setup the caller can read.
apiKeyheader
x-api-key<token>id*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$Format
uuidRecipeSetup
application/json- response
id*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$Format
uuidrevision*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$Format
uuidreferences*updatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.integrationCatalog.recipeSetupGet({
"id": "example"
});Example Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": "b587a570-d9a5-40c2-87da-edba28b3005f",
"references": {
"channel": "email",
"templateFamilyId": "string",
"integrationAccountId": "string",
"publicationId": "string",
"senderId": "string",
"whatsappAccountId": "string",
"registrationId": "string",
"mailboxEndpointId": "string",
"journeyId": "string",
"eventBindings": {
"property1": "string",
"property2": "string"
}
},
"updatedAt": "string"
}