{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/webhooks/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"How to set up webhooks in Dixa","description":"Start building with the Dixa API","siteUrl":"https://docs.dixa.io/","keywords":"dixa developer hub, api portal starter, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"how-to-set-up-webhooks-in-dixa","__idx":0},"children":["How to set up webhooks in Dixa"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To set up an outbound webhook, you need to be a Dixa administrator, as you need to be able to access the settings of your organization in Dixa."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings > Integrations"]}," and click on the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhooks"]}," tab. Here you will find the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Outbound webhooks"]}," table. Click on the button ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add outbound webhook"]}," to navigate to the creation page."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/setup-webhooks.ed7100c254b224396874f5c3f5b1c34aede3a9992125201754abb8683783ac08.a97e1638.png","alt":"Setup Webhooks"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["\"Add webhook.\""]}," and fill in the required details:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/fill-in-details.a434eb38e5d576eb4cb02a3017085a33a6f1fcf0f0ccaa9bad04ea2605ad6717.a97e1638.png","alt":"Fill in Details"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Name"]},": Provide a descriptive name here, so you can identify your webhook later, e.g. \"CRM updates.\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhook URL"]},": Specify the URL that the events should be sent to. This could be an API from your internal system or another third-party system (e.g. Salesforce, Hubspot, Pipedrive, etc.)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enable"]},": If you want to enable your webhook subscription straight away, you can toggle it here. If you first want to test the subscription elsewhere, you can also save your webhook in a disabled state."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorization"]},": Specifying additional headers is optional but might be required by the third-party system's API. You can add a basic authorization header or a token authorization header."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom header"]},": In case the basic or token authorization header doesn't cover your needs, you can also add a custom header. It's a regular key-value pair."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Events to subscribe to"]},": Select the events you are interested in getting notified about. You can read about the available event types and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads"},"children":["payloads"]}," further below."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Filters"]},": Filters allow a more granular selection of events to listen to. Only filtered events will be sent out; they can target the conversation channel, queue, and event origin."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event origin"]}," can be used to suppress events originating from activities such as ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.dixa.io/openapi/dixa-api/v1/conversations/postconversationsimport"},"children":["importing conversations"]}," via the API. Currently, the supported events are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Created"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Assigned"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Message added"]},"."]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/add-filters-2.7715784101f6fc4b7543dd43d1af2a1f51f8fdabde81990f5f39054f4797b2ad.a97e1638.png","alt":"Filters"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]}," to save the new webhook and reveal the option to copy the verification secret for it."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/webhook-added.ad8fc702b9a3e97df2b73686520f6593b13be475aa8dfb71ea2dae8e8bfb30ef.a97e1638.png","alt":"Webhook Added"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Done!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Changes to the webhook configuration, or removals of webhooks can be done from the webhooks overview page."]}]},"headings":[{"value":"How to set up webhooks in Dixa","id":"how-to-set-up-webhooks-in-dixa","depth":1}],"frontmatter":{"seo":{"title":"How to set up webhooks in Dixa"}},"lastModified":"2026-04-09T11:32:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/webhooks/webhooks-setup","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}