DocuSign Connect: XML SIM messaging format deprecated
Following on the heels of our release of DocuSign Connect 2.0, which introduces the new JSON format for our Send Individual Messages (SIM) messaging model, DocuSign is announcing the deprecation of the SIM model in the legacy XML messaging format. If your existing Connect listener uses XML SIM format, you will need to update your code accordingly.
Timeline
Deprecation of the XML SIM messaging format will occur over 12 months, from May 1, 2022 to May 1, 2023, in these stages:
- August 2022: We will remove the configuration choice for XML SIM format for Connect from the DocuSign web UI, making it impossible to choose XML SIM format for new integrations.
- November 2022: We will end developer support for XML SIM cases.
- May 2023: We will complete all remaining XML SIM transactions and stop sending Connect messages in XML SIM format entirely.
Following these events, DocuSign will continue to support these Connect messaging formats:
- JSON, Send Individual Messages (JSON SIM)
- JSON, Aggregate Messages
- XML, Aggregate Messages
Update options
To adapt to the deprecation of the XML SIM messaging format, you have three choices:
Option 1 (recommended): Recreate XML SIM configurations as JSON SIM
Recreate any XML SIM configurations in your account. Use JSON SIM for the new configurations instead. This method offers more trigger events than our legacy XML format.
Before you start, have your IT team check to see whether your HTTPS listener requires code changes to work with JSON SIM. You should also decide which trigger events you want to use.
- Create a JSON SIM configuration by following the steps in Create a Custom Connect Configuration. Use these settings:
- For the Status, select Active Connection.
- For the Data Format, select REST v2.1.
- For the Event Message Delivery Mode, select Send Individual Messages (SIM).
- Repeat these steps for any additional configurations.
- After any necessary changes to your listener are completed, test the new configurations.
- Change the status of the XML SIM configurations to deactivate them.
Option 2: Create an XML Aggregate configuration for each event
Some organizations might need to use SIM, but lack the resources to recreate configurations to use JSON. In these cases, create a separate XML Aggregate configuration for each trigger event. This approach simulates an XML SIM configuration.
Note: Failures show the latest envelope status. Failures don’t show the status when the event that failed to publish to your listener was triggered.
Before you start, decide which trigger events you want to use. You should also have your IT team check if your HTTPS listener requires code changes to support this approach.
- Create an XML Aggregate configuration by following the steps in Create a Custom Connect Configuration. Use these settings:
- For the Status, select Active Connection.
- For the Data Format, select Legacy.
- For the Event Message Delivery Mode, select Aggregate.
- Select Envelope and Recipients. The panel expands to show a list of envelope and recipient events.
- Select only one event.
- Finish creating the configuration as usual.
- After any necessary changes to your listener are completed, test the new configuration.
- Repeat these steps for any other events you want to use.
- Change the status of the XML SIM configurations to deactivate them.
Option 3: Deactivate SIM for the account to automatically use XML Aggregate
If you don’t need to use SIM but still want to use XML, you can deactivate SIM for the account. Before you start, have your IT team check if your HTTPS listener requires code changes to support this approach.
Important: We recently added the Event Message Delivery Mode setting at the configuration level. Deactivating SIM at the account level might not affect all configurations. You should still double-check that all of your configurations are set to Legacy data format and Aggregate delivery mode. Contact DocuSign Support if you need assistance.
- Log in to the account and select Settings > Updates.
- Next to the listing for Connect - Send Individual Messages updates, select DEACTIVATE.
Connect begins to send updates to your listener in XML format through aggregate delivery mode.
Who can I contact if I have additional questions?
For questions or for additional assistance, create a support case by logging in to the DocuSign Support Center. A support expert will be available to assist you.
