Use this endpoint to register a new webhook subscription. Once created, the platform sends HTTP POST requests to your specified URL whenever the selected event type occurs (e.g., shipment status change, surcharge applied).

When to use this endpoint

• Setting up event-driven integrations that react to shipment status changes
• Triggering order fulfillment workflows when tracking updates arrive
• Keeping external dashboards or ERPs in sync with Envia events
• Configuring billing alerts for surcharges and refunds

Considerations

• The url must be a publicly reachable HTTPS endpoint capable of receiving JSON POST requests
• Retrieve available event types from Webhook types to get the correct type_id
• Set active to 0 to create the webhook in a disabled state for testing before enabling it
• Multiple webhooks can be registered for the same event type with different URLs
• Returns the created webhook object with its assigned id, which can be used with Update webhook

Related endpoints

• Webhook types — look up available event types before creating
• All webhooks available — verify the subscription was created
• Update webhook — modify URL, type, or active status later