Home
API Reference

Add a new Webhook

post
https://api.smtp2go.com/v3/webhook/add

Add a new webhook with the given configuration. Setup of webhooks can be done on the Settings > Webhooks page in your SMTP2GO control panel.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The URL of the webhook.

events
array of strings

A list of events the webhook will receive, from this list [delivered,unsubscribe,spam,bounce,processed,reject,click,open].

events
sms_events
array of strings

A list of SMS events the webhook will receive, from this list [delivered,failed,rejected,sending,submitted].

sms_events
headers
array of strings

Custom headers you would specifically like sent in the event data. The headers must already exist in the emails. Subject and Message-id headers are sent by default.

headers
usernames
array of strings

Usernames to be included in this webhook. All usernames will be included if none are specified.

usernames
string
Defaults to form

The format of the webhook data. Either form or json.

string

If you wish to make this API call on behalf of a subaccount then include its unique ID here.

string

The type of authentiction header, Either bearer or basic or empty for no authentication.

string

The value of authentiction header, Either base64(user:pass) or a custom token.

Responses

Updated 8 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago