Webhooks
You can send webhook notifications from Heretto CCMS that can trigger various actions on external servers. External servers can be configured to pull content from the CCMS on a webhook notification.
Webhooks can be configured for all cloud publishing engines that are an integral part of the CCMS. For more information, see Heretto Publishing Overview.
This functionality may not be available by default in Heretto CCMS. For more information, contact your Customer Success Manager.
By default, when the CCMS sends a webhook notification, it waits for up to three minutes to get a response. If it receives no response, it reports an error with the target server. This webhook timeout is configurable. For details, contact your Customer Success Manager.
Webhook notifications on publish
You can send webhook notifications automatically on successful publishing jobs or on any publishing job.
- Do not send
- Webhook notification is not sent.
- Send on success
- Webhook notification is sent after a publishing job is completed successfully.
- Send regardless of build result
- Webhook notification is sent for both successful and unsuccessful publishing jobs.
Webhook notifications on demand
You can manually send webhook notifications for past publishing jobs and resources in your Content Library.
Triggering Actions on External Servers with Webhooks (Notify)
Your Heretto CCMS instance can be configured to send webhook notifications about publishing events to external servers. On a webhook notification, the external server can trigger various actions. For example, the external server can automatically send emails on successful publish jobs.
In the following example, a publishing job is initiated in Heretto CCMS. The publishing job generates output in Heretto CCMS. If the publishing job is successful, then the CCMS sends a webhook notification to the external server. The external server triggers actions based on the webhook notification.
Pulling Content from Heretto CCMS to External Servers (NotifyPull)
External servers may be configured to pull content from Heretto CCMS on a webhook notification.
The majority of output formats produced by the DITA Open Toolkit (DITA-OT) publishing engine1 can be pulled from Heretto CCMS to an external server.
Publishing Content on External Servers with Webhooks (NotifyPull)
External servers may be configured to pull DITA content from Heretto CCMS on a webhook notification and transform the pulled content.
Sending a webhook notification for source content is useful if you want to process DITA content by using a publishing engine hosted on an external server.
In the following example, a webhook notification is sent from Heretto CCMS. The external server triggers a publishing engine that pulls and transforms the source content from Heretto CCMS. The output is generated on the external server side.