Sign in
WEBHOOKS

Add a new Webhook

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

post/webhook/add

Request body

urlstring required

The URL of the webhook.

eventsstring[]

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

sms_eventsstring[]

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

headersstring[]

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.

usernamesstring[]

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

output_formatstring

The format of the webhook data. Either <code>form</code> or <code>json</code>.

subaccount_idstring

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

auth_header_typestring

The type of authentiction header, Either <code>bearer</code> or <code>basic</code> or empty for no authentication.

auth_header_valuestring

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

Response

Webhook added

request_idstring required

Example response

{
  "data": {
    "url": "https://example.com/test-webhook"
  },
  "request_id": "4b661d88-6b2d-11eb-8bb3-f23c92bb31d2"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.