Register Webhook

POST 
/v1/webhook/register

This endpoint registers webhook

Request

application/json

Body

required

Webhook Payload

event stringrequired

Possible values: [EMAIL_EVENT, DOMAIN_VERIFICATION]

headers

object

property name* string
method stringrequired

Possible values: [GET, POST, PUT, DELETE, PATCH]

webhook_options

object

events

object

bounce boolean

click boolean

delivery boolean

generation_failure boolean

generation_rejection boolean

open boolean

policy_rejection boolean

spam boolean

unsubscribe boolean
webhook_url stringrequired

Responses

200

Webhook created

application/json

Schema

Schema

message string
success boolean

Example (from schema)

{
  "message": "webhook created",
  "success": true
}

400

Bad Request

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

409

Conflict Webhook Already Exists

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

422

Unprocessable Entity Not able to connect to the provided url

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

Loading...