Webhook Config API — Get and Save Webhook Settings

Authentication

All endpoints accept either an ApiKey header or an OAuth header. See the OAuth Endpoints page for token generation.

Get Webhook Config

Returns the current webhook configuration for your account, including enabled event types, callback URLs, and enabled state. No request body parameters are required.

Request Body

This endpoint takes no parameters. Pass an empty JSON object ({}) as the request body.

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

object

Object indicating which event types are currently enabled for webhook delivery. Returns null if no configuration has been saved yet. Each key corresponds to an event type; true means notifications for that event are enabled.

Show transEvent object

boolean

true if webhook notifications are enabled for dropped messages.

boolean

true if webhook notifications are enabled for bounced messages.

boolean

true if webhook notifications are enabled for delivered messages.

boolean

true if webhook notifications are enabled for spam reports.

boolean

true if webhook notifications are enabled for opens.

boolean

true if webhook notifications are enabled for link clicks.

boolean

true if webhook notifications are enabled for unsubscribes.

string

Default callback URL that receives webhook payloads for all senders without a specific override. Returns null if not configured.

array[object]

Per-sender callback URL overrides. Each object routes events from a specific sender to a dedicated endpoint. Returns null if not configured.

Show transCallbackUrlExtra object

string

The sender email address this override applies to.

string

The callback URL that receives events for this sender.

boolean

true if webhook delivery is globally enabled; false if all webhooks are paused. Returns null if not configured.

curl --request POST \
  --url https://api.effilink.co/v5/webhook/get \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{}'

Response

{
  "code": 200,
  "message": "",
  "transEvent": {
    "dropped": true,
    "bounced": true,
    "delivered": true,
    "spamReport": false,
    "opened": true,
    "clicked": true,
    "unsubscribed": false
  },
  "transCallbackUrl": "https://yourapp.com/webhooks/effilink",
  "transCallbackUrlExtra": [
    {
      "sender": "newsletter@yourdomain.com",
      "url": "https://yourapp.com/webhooks/newsletter"
    }
  ],
  "transEnable": true
}

Save Webhook Config

Updates one or more webhook configuration settings. All fields are optional — only the fields you include will be modified.

Request Body

object

Object controlling which event types trigger webhook notifications. Include only the keys you want to change; omitted keys retain their current values. Set a key to true to enable notifications for that event, or false to disable them.

Show transEvent object

boolean

Enable (true) or disable (false) webhook notifications for dropped messages.

boolean

Enable (true) or disable (false) webhook notifications for bounced messages.

boolean

Enable (true) or disable (false) webhook notifications for delivered messages.

boolean

Enable (true) or disable (false) webhook notifications for spam reports.

boolean

Enable (true) or disable (false) webhook notifications for opens.

boolean

Enable (true) or disable (false) webhook notifications for link clicks.

boolean

Enable (true) or disable (false) webhook notifications for unsubscribes.

string

Default callback URL to receive webhook payloads. Used for all senders that do not have a per-sender override. Must be an http:// or https:// URL.

array[object]

Per-sender callback URL overrides. Behavior is controlled by transCallbackUrlExtraUpdateMode. To remove an existing override for a sender, pass that sender with an empty string "" for url.

Show transCallbackUrlExtra object

string

required

The sender email address this override applies to.

string

The callback URL that should receive events for this sender. Must be an http:// or https:// URL. Pass an empty string to remove an existing override for this sender.

string

Determines how transCallbackUrlExtra entries are applied:

"save" — Add new entries and update existing ones; all other entries are preserved. This is the default.
"replace" — Replace the entire per-sender override list with the provided entries.

boolean

Set to true to enable webhook delivery globally, or false to pause all webhook notifications.

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

curl --request POST \
  --url https://api.effilink.co/v5/webhook/save \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "transEvent": {
      "dropped": false,
      "bounced": true,
      "delivered": true,
      "spamReport": false,
      "opened": true,
      "clicked": true,
      "unsubscribed": false
    },
    "transCallbackUrl": "https://yourapp.com/webhooks/effilink",
    "transEnable": true
  }'

curl --request POST \
  --url https://api.effilink.co/v5/webhook/save \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "transCallbackUrlExtra": [
      {
        "sender": "alerts@yourdomain.com",
        "url": "https://yourapp.com/webhooks/alerts"
      }
    ],
    "transCallbackUrlExtraUpdateMode": "save"
  }'

curl --request POST \
  --url https://api.effilink.co/v5/webhook/save \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "transEnable": false
  }'

Response

{
  "code": 200,
  "message": ""
}

Transactional Email

Campaign Email

SMS

Contacts & Lists

Webhooks

Authentication

Webhook Config API — Get and Save Webhook Settings

Authentication

Get Webhook Config

Request Body

Response

Save Webhook Config

Request Body

Response

​Authentication

​Get Webhook Config

​Request Body

​Response

​Save Webhook Config

​Request Body

​Response

Authentication

Get Webhook Config

Request Body

Response

Save Webhook Config

Request Body

Response