Webhooks Endpoints

Add a webhook to subscribe for Sendiio events (new emails in list, unsubscribes, etc.)

• URL

  /api/v1/webhook/add

• Method:

  POST

• Data Params

  Required:
  url=[string](required)
  email_added=[int](optional. Available values: 1, 0)
  opened=[int](optional. Available values: 1, 0)
  clicked=[int](optional. Available values: 1, 0)
  unsubscribed=[int](optional. Available values: 1, 0)

• Response Examples:

  • Code: 200
    Content:

{
    "error": 0,
    "msg": "Webhook events successfully created/updated",
    "data": []
}

• Code: 401
  Content:

{
    "error": 1,
    "msg": "Validation errors",
    "errors": [
        "url": [
            "The url field is required."
        ]
    ],
    "data": []
}

Get all webhooks for Sendiio events

Get all webhooks subscriptions for Sendiio events

• URL

  /api/v1/webhook/get

• Method:

  GET

• Response Examples:

  • Code: 200
    Content:

{
    "status": true,
    "msg": "OK",
    "data": [
        {
            "url": "http://example.com",
            "events": {
                "email_added": true,
                "clicked": false
            }
        }
    ],
    "error": 0
}

Delete webhook for Sendiio events

Delete webhook for Sendiio events

• URL

  /api/v1/webhook/delete/{webhook_id}

• Method:

  GET

• Response Examples:

  • Code: 200
    Content:

{
    "status": true,
    "msg": "Webhook successfully deleted.",
    "data": [],
    "error": 0
}