Add a webhook to an incoming domain

POST 
/v1/inbound/relay_webhook

This endpoint adds a webhook to a specified incoming domain

Request

application/json

Body

required

Incoming Domain Payload

domain stringrequired
headers object
method stringrequired

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

url stringrequired

Responses

200

Webhook added successfully

application/json

Schema

Schema

message string
success boolean

Example (from schema)

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

400

error: Invalid Payload

application/json

Schema

Schema

error string
success boolean

Example (from schema)

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

412

error: Precondition Failed

application/json

Schema

Schema

error string
success boolean

Example (from schema)

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

500

error: Internal Server Error

application/json

Schema

Schema

error string
success boolean

Example (from schema)

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

Loading...