Configurable options

Different systems may have different requirements possibly making certain CAP API functionalities unwanted Because of this clients may configure their account respectively to either include or exclude certain functionalities to their liking For example messages sent using the API will automatically have events pushed to the Common Transaction Log for statistics and billing purposes As some systems might have their own solution for handling message related events this functionality can be disabled for an account through configuration Receiver SMP lookups When POSTing a new message to the API an SMP lookup will be attempted in order to verify the existence of the receiving party However the result of this operation is ignored if either a response is not received in a timely manner a response was received but the result is inconclusive Otherwise the message is either rejected synchronously if the receiver doesn t exist is unable to receive that particular document or accepted persisted and awaiting transmission An SMP lookup will also be attempted during transmission unrelated to this configuration A failure here will result in the message being put in a FAILED state visible to the client through other API methods unlike during the POST request in which a message is never stored at all fail fast This configuration enabled by default Disabling it will only avoid SMP lookups during the API request A lookup will still be attempted before transmission Payload validation The API may also attempt to validate message payloads if configured for it As with SMP lookups the result of this attempt is also ignored if either a response is not received in a timely manner a response was received but the result is inconclusive Otherwise the message is either rejected synchronously if the validation fails or accepted for pending transmission if successful In case no successful validation result was achieved during POST then the API will retry the validation once more before the transmission unrelated to this configuration This configuration enabled by default Disabling it will only avoid validation during the API request A validation will still be attempted before transmission Message events to Common Transaction Log The API may send the following message events to Common Transaction Log A CREATED event representing the message in its pending state before transmission And either A DELIVERED event representing the message after a successful transmission Or A FAILED event representing the message after a failed transmission depending on the message transmission outcome This configuration is disabled by default Webhook for push notifications coming soon This functionality is currently planned but not yet implemented