{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/it/products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Performance and scaling","description":"Integration and usage documentation."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"performance-and-scaling","__idx":0},"children":["Performance and scaling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Performance-related guidance derived from the Namirial Notify API references."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API references do not publish explicit throughput limits, concurrency"," ","ceilings, or rate-limit headers. Design your"," ","integration conservatively and validate expected traffic with your Namirial"," ","Notify contact before go-live."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prefer-callbacks-over-frequent-polling","__idx":1},"children":["Prefer callbacks over frequent polling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Callbacks are the most efficient way to follow transaction progress."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," for near-real-time"," ","tracking."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reserve Query and Get operations for reconciliation, scheduled audits, and"," ","recovery when callbacks were missed or delayed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Make callback processing idempotent so retries do not create duplicate"," ","internal updates."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/dev/callbacks"},"children":["Callbacks and webhooks"]}," for retry behavior."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-efficiently","__idx":2},"children":["Query efficiently"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When querying large result sets:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Filter by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithUniqueIds"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithLookupKeys"]},", state, or outcome whenever"," ","possible."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Offset"]}," for EviMail, EviSMS, and EviPost."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cursor"]}," for EviNotice."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Avoid broad unfiltered reconciliation jobs if you already know the specific"," ","IDs or lookup keys you need."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-large-payloads-only-when-needed","__idx":3},"children":["Retrieve large payloads only when needed"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Metadata-heavy responses are useful, but more expensive than plain status queries."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["EviMail, EviSMS, and EviPost:"]}," Request ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavits"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAttachments"]}," ","(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavitsOnResult"]}," for EviPost) only when your process actually needs the"," ","metadata. EviPost has no attachment include flag."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["EviNotice:"]}," Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavits"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAttachments"]}," on the Get endpoint"," ","for metadata. To retrieve file content, use the dedicated ZIP download endpoints"," ","(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/Affidavits"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/Attachments"]},") only when your process actually needs the files."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Separate status-tracking jobs from file-download jobs in your integration."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"protect-submit-operations-from-duplication","__idx":4},"children":["Protect submit operations from duplication"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," on Submit requests across all services (EviMail, EviSMS, EviNotice, EviPost)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For all services, use your own ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}," strategy so retries and support"," ","workflows can be correlated safely."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not retry a failed submit blindly if you cannot determine whether the"," ","upstream system already accepted it."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"bulk-and-campaign-planning","__idx":5},"children":["Bulk and campaign planning"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviNotice, EviMail, and EviSMS all expose a dedicated ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["batch API"]}," for sending the same"," ","certified communication to many recipients as a single managed job. See the service"," ","reference pages for the full workflow and CSV recipient format:"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evinotice-api#batch-operations"},"children":["EviNotice batch"]},","," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evimail-api#batch-operations"},"children":["EviMail batch"]},","," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evisms-api#batch-operations"},"children":["EviSMS batch"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For planning a batch campaign:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the batch API rather than repeated single-submit calls — it provides progress"," ","tracking (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SentCount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FailedCount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProgressPercentage"]},") and a managed lifecycle."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Upload recipients as a single ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text/csv"]}," file, then query the batch or recipient list"," ","to review the imported totals before starting processing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Configure ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchPushNotificationUrl"]}," on the batch when"," ","generated evidences should send the normal per-evidence callbacks. Track the"," ","batch lifecycle itself by polling the batch resource."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ScheduledDate"]}," to spread load and coordinate expected campaign size and traffic"," ","profile before production launch."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use pre-production to validate request construction and lifecycle handling before"," ","increasing load."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Because no portal-wide rate-limit policy is documented, do not assume that"," ","aggressive parallelism or tight retry loops are safe."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"evidence-retrieval-strategy","__idx":6},"children":["Evidence retrieval strategy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Affidavits, attachments, and original documents can be significantly larger than"," ","status-only responses."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fetch evidence when a downstream business step needs it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Cache the fact that evidence was already retrieved."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Avoid downloading the same blobs repeatedly during reconciliation jobs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For EviPost on-demand affidavits, treat generation and pickup as a separate"," ","asynchronous process."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pre-production-validation-checklist","__idx":7},"children":["Pre-production validation checklist"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm expected traffic profile and peak volume assumptions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Test callback handling under retries and delayed delivery."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Measure the cost of metadata-only queries versus blob-heavy retrieval."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm how and when affidavits should be fetched in the target business"," ","process."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Validate operational dashboards and alerting before switching to production."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":8},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/dev/integration-patterns"},"children":["Integration workflows"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/dev/callbacks"},"children":["Callbacks and webhooks"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/dev/security-best-practices"},"children":["Security and authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/overview"},"children":["API reference overview"]}]}]}]},"headings":[{"value":"Performance and scaling","id":"performance-and-scaling","depth":1},{"value":"Prefer callbacks over frequent polling","id":"prefer-callbacks-over-frequent-polling","depth":2},{"value":"Query efficiently","id":"query-efficiently","depth":2},{"value":"Retrieve large payloads only when needed","id":"retrieve-large-payloads-only-when-needed","depth":2},{"value":"Protect submit operations from duplication","id":"protect-submit-operations-from-duplication","depth":2},{"value":"Bulk and campaign planning","id":"bulk-and-campaign-planning","depth":2},{"value":"Evidence retrieval strategy","id":"evidence-retrieval-strategy","depth":2},{"value":"Pre-production validation checklist","id":"pre-production-validation-checklist","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"Performance and scaling","description":"Practical guidance for efficient querying, evidence retrieval, and production-scale usage of the Namirial Notify APIs.","layout":"doc","outline":"deep","keywords":["performance","scaling","pagination","callbacks","rate limiting","namirial notify api"],"seo":{"title":"Performance and scaling"}},"lastModified":"2026-07-22T12:38:27.000Z","isTranslationFallback":true,"pagePropGetterError":{"message":"","name":""}},"slug":"/it/products/namirialnotify/dev/performance-guidelines","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}