Overview

Call this endpoint as a GET request to get a list of the configured webhooks associated with your account.

Endpoint

Method URL
GET https://api.everlytic.net/transactional/email/v1/webhooks

Example Request

curl --location 'https://api.everlytic.net/transactional/email/v1/webhooks'

Response

Status codes

Status code Explanation
200 Ok Webhook was created successfully
401 Unauthorized The provided authorization credentials are incorrect

Properties

Properties of response with status 200 OK

Property Sub-properties Description Data type Parameters
type Type of resource listed string
  • webhook
meta total Total amount of pages returned integer
per_page Number of webhooks listed per page integer
current_page The current page number integer
last_page The number of the last page of the results. integer
from The number of the previous page integer
to The number of the next page integer
links first The URL for the first page of results string Valid URL
last The URL for the final page of results string Valid URL
prev The URL for the previous page string Valid URL
next The URL for the next page string Valid URL
data id The ID that will be used to identify the webhook in future requests string
url The URL that will receive the webhook event string Valid URL
verb  The HTTP method that will be used by the webhook enum (string)
  • get
  • put
  • post
  • patch
  • delete
auth_details Authorization details required by the provided webhook URL. JSON
  • username
  • password
  • username
 The username required by the provided webhook URL string
  • password
  The password required by the provided webhook URL string
auth_type The type of authorization used by the provided webhook URL enum (string)
  • basic
status The current state of the new webhook enum (string)
  • enabled
  • disabled
settings Optional settings used for this webhook. JSON
  • include_html
  • include_html
 Setting to enable sending transactional email’s HTML content as part of webhook payload.
HTML content is only sent as part of “sent” event types and only part of the “legacy” field set.		 boolean
  • true
  • false
content_type The original media type (prior to any content encoding applied for sending) used for the webhook payload. enum (string)
  • application/x-www-form-urlencoded
  • application/json
field_set The format of the webhook payload. Set to “legacy” to use the format of legacy transactional callbacks. enum (string)
  • standard
  • legacy
updated_timestamp The date and time that the webhook was last updated date-time ISO 8601 date-time string
created_timestamp The date and time that the webhook was initially created date-time ISO 8601 date-time string
event_types Array containing the type of event that will trigger the webhook array (string)
  • sent
  • delivered
  • failed
  • open
  • click
  • bounce
  • unsubscribe
  • resubscribe

 

Properties of response with status 401 Unauthorized

Property Description Data type Parameters
code The HTTP response status code integer
  • 401
message The reason for the failure string Valid string
error Array containing errors field JSON
  • errors
errors Array containing the failure details JSON
  • domain
  • reason
  • message
  • locationType
  • location
domain The classification of the type of error string
  • global
reason Keyword used to describe the error string
  • required
message Text describing the reason for the failure string Valid string
locationType The location where the failure occurred string
  • request
location The type of validation that failed string
  • authorization

Example Response

Successful response with contents [200 OK]

{
  "type": "webhooks",
  "meta": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  },
  "links": {
    "first": "https://api.everlytic.net/transactional/email/api/v1/webhooks?page=1",
    "last": "https://api.everlytic.net/transactional/email/api/v1/webhooks?page=1",
    "prev": null,
    "next": null
  },
  "data": [
    {
      "id": "98765d91-fa6e-43f6-8e6a-1f6429fb285b",
      "url": "https://your.webhook.url",
      "verb": "post",
      "auth_details": {
        "username": "administrator",
        "password": “Password123"
      },
      "auth_type": "basic",
      "status": "enabled",
      "settings": "{\"include_html\":false}",
      "content_type": "application/json",
      "field_set": "standard",
      "updated_timestamp": "2023-08-07T14:10:03.000Z",
      "created_timestamp": "2022-01-31T11:22:50.000Z",
      "event_types": [
        "sent"
      ]
    }
  ]
}

Successful response with no contents [200 OK]

{
    "type": "webhooks",
    "meta": {
        "total": 0,
        "per_page": 1,
        "current_page": 1,
        "last_page": 0,
        "from": 1,
        "to": 1
    },
    "links": {
        "first": null,
        "last": null,
        "prev": null,
        "next": null
    },
    "data": []
}

Invalid/Missing authorization credentials [401 Unauthorized]

{
    "code": 401,
    "message": "Login Required",
    "error": {
        "errors": [
            {
                "domain": "global",
                "reason": "required",
                "message": "Login Required",
                "locationType": "request",
                "location": "authorization"
            }
        ]
    }
}