WEBHOOKS

Get webhook endpoint metadata

GET/v1/webhook-endpoint

See the request and response contract below.

Backend integrationYour backend and SDK use a tenant API key.

Try itAvailable for creating, reading, and deleting verification sessions in Test. Other operations are reference-only; API-key protected routes require a tenant API key on your backend. Open a session request

Responses

Response 200

JSON response

application/json · Response schema

client_idstringrequired
urlstring · urirequired
created_atstringrequired
host_statusstringrequired: Operator review status of the endpoint's hostname. Delivery only reaches APPROVED hosts.
Allowed valuesPENDINGAPPROVEDREJECTED
host_review_notestring,nulloptional: Operator-provided reason, set when host_status is REJECTED.

View JSON schema

{
  "type": "object",
  "required": [
    "client_id",
    "url",
    "created_at",
    "host_status"
  ],
  "properties": {
    "client_id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "created_at": {
      "type": "string"
    },
    "host_status": {
      "type": "string",
      "enum": [
        "PENDING",
        "APPROVED",
        "REJECTED"
      ],
      "description": "Operator review status of the endpoint's hostname. Delivery only reaches APPROVED hosts."
    },
    "host_review_note": {
      "type": [
        "string",
        "null"
      ],
      "description": "Operator-provided reason, set when host_status is REJECTED."
    }
  }
}

Response 401

Error response

application/json · Response schema

errorstringrequired
messagestringrequired

View JSON schema

{
  "type": "object",
  "required": [
    "error",
    "message"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Response 403

Error response

application/json · Response schema

errorstringrequired
messagestringrequired

View JSON schema

{
  "type": "object",
  "required": [
    "error",
    "message"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Response 404

Error response

application/json · Response schema

errorstringrequired
messagestringrequired

View JSON schema

{
  "type": "object",
  "required": [
    "error",
    "message"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

← All public operations