Set up webhooks
With webhooks (also called HTTP callbacks) you can instruct the tebio Business portal to automatically notify external systems when certain events occur. Instead of regularly asking for new events via API (polling), tebio automatically sends an HTTP POST to a URL configured by you.
When do I need this function?
Section titled “When do I need this function?”Use webhooks, for example, if you:
- want to synchronize new customer registrations into your CRM system (e.g. Salesforce, HubSpot) (
customer.user.create). - Want to transfer status changes of orders to an ERP or logistics system (
order.updated). - Want to trigger automated processes in your own backend as soon as certain events are triggered.
Requirements
Section titled “Requirements”- You need administrative rights to access the Developer area.
- You need an HTTPS URL of a listening endpoint that can accept and process POST requests.
Step-by-step instructions
Section titled “Step-by-step instructions”Navigation
Section titled “Navigation”- Click on the Terminal icon in the top right menu bar.
- Switch to the Webhooks tab in the tab navigation.
Manage existing endpoints
Section titled “Manage existing endpoints”In the overview The following endpoints are configured you can see all the webhooks that have already been created:
- URL: The destination address to which the payload will be sent.
- Reference: Internal name for this endpoint.
- Status: Indicates whether the webhook is currently
Aktiviertor disabled. - Delete: You can use the trash can icon to delete endpoints that are no longer needed.
Add new endpoint
Section titled “Add new endpoint”To register a new webhook, click the Add Endpoint button. A dialog opens with the following configuration options:
- Reference: Assign a unique internal name (e.g. “CRM Sync Prod”).
- URL (required): Enter the full HTTPS destination address (e.g.
https://webhook.ihredomain.de/tebio/webhook). - Enable endpoint: This switch is active by default. If you disable it, the webhook will be saved but paused.
- HMAC Key: An optional but recommended security feature. If you store a secret key here, tebio will sign the request body. Your receiving system can then validate the signature to ensure that the request came from tebio and was not tampered with along the way.
- Description: Optional field for additional notes (e.g. contact person or affected third-party system).
- Events: Here you specify which events are sent to the endpoint.
- ALL: The endpoint receives every event that occurs in the portal (note that this may result in high traffic).
- None: Temporarily suspends delivery of events.
- List: Allows you to make specific selections. Once you select “List” another drop down menu Select Event Type Codes will appear. Here you can specifically select the events that you are interested in (e.g.
order.updated,product.resource_definition.updateor payment events).
- Confirm your configuration with Create.
Result
Section titled “Result”The webhook endpoint is saved. If the endpoint is active and suitable events have been selected, tebio will send events to the configured URL in the future.
API Notes
Section titled “API Notes”The following REST endpoints are available for management via the API:
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/settings/event/webhook/endpoint | GET | Find or list webhook endpoints | searchWebhookEndpoint |
/v1/settings/event/webhook/endpoint | POST | Create webhook endpoint | createWebhookEndpoint |
/v1/settings/event/webhook/endpoint/{uid} | GET | Get details of a webhook endpoint | getWebhookEndpoint |
/v1/settings/event/webhook/endpoint/{uid} | PUT | Replace or update webhook endpoint | replaceWebhookEndpoint |
/v1/settings/event/webhook/endpoint/{uid} | DELETE | Delete webhook endpoint | deleteWebhookEndpoint |