Skip to content


The Inbound Webhook analyze the header and body of the received email and notifies the endpoint of this in an HTTP request. It can be used as an interface for the system to process received emails such as blank emails and email forms.

API Settings

To use Inbound Webhook, you need to set the API from the management console.

Please refer to User Guide -> "API" -> Webhook and perform the API settings.


The Inbound Webhook posts the following parameters to the endpoint when it receives an email.

Parameter Required Data Type Description
api_key No ASCII If you set the API key on the management console, the specified API key will be sent.
server_composition Yes UTF-8 Sends the name of the server configuration that this event occurred.
filter Yes UTF-8 Send the reception notification name set in Webhook of the management console -> Inbound.
headers Yes UTF-8 Sends the header of the received email in JSON format.
text No UTF-8 Sends the text body of the received email.
html No UTF-8 Sends the HTML body of the received email.
subject Yes UTF-8 Sends the subject of the received email.
envelope-from Yes ASCII Sends the envelope from of the received email.
envelope-to Yes ASCII Sends the envelope to of the received email.
attachments Yes INTEGER Send the number of attachments in the email you received. If the attachment does not exist, its value is '0'.
attachmentN No BINARY If a file is attached to the received email, the attached file will be sent in the file upload format.The N in the parameter name attachment is the sequence number of the attachment. Sequence numbers start at 1 and end with 'attachments'.


The JSON format of the headers parameter is a list of objects that have 'name' and 'value' in the properties. Mapping the email header and its value.

        "name" : "return-path",
        "value" : ""
        "name" : "To",
        "value" : ""
        "name" : "From",
        "value" : ""
Property Description
name Name of the mail header
value Value of the mail header