API reference ยท Webhooks
POST
/v1/webhook-endpoints/{endpoint_id}/enableResume an endpoint.
Read and trade
Path parameters#
-
The endpoint.
Responses#
200OK
-
The endpoint.
-
Its address: the host and the start of the path (never whole: chat addresses carry tokens).
-
json: the signed event. discord, slack, telegram: a chat message.
One of
jsondiscordslacktelegram -
The groups it receives (see GET /v1/webhook-event-types).
-
disabled: we stopped after failures in a row; turn it on again from your dashboard.
One of
activepauseddisabled -
The version its events are written in.
-
Its environment: it receives that environment's events only.
One of
livesandbox
401The request has no Authorization header.
{
"error": {
"type": "authentication",
"code": "missing_api_key",
"message": "No API key: send it as Authorization: Bearer <key>.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": false,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#missing_api_key"
}
}403The key only works from the addresses you listed.
{
"error": {
"type": "permission",
"code": "ip_not_allowed",
"message": "This address is not on the key's allowlist.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": false,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#ip_not_allowed"
}
}404The id is unknown, or belongs to another customer or environment.
{
"error": {
"type": "not_found",
"code": "webhook_endpoint_not_found",
"message": "No webhook endpoint with that id.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": false,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#webhook_endpoint_not_found"
}
}429A request budget is used up (details.scope says which).
{
"error": {
"type": "rate_limit",
"code": "rate_limited",
"message": "Too many requests: slow down.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": true,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#rate_limited"
}
}500An error we did not expect.
{
"error": {
"type": "server",
"code": "internal_error",
"message": "Something went wrong on our side.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": true,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#internal_error"
}
}503A service this call needs did not answer.
{
"error": {
"type": "server",
"code": "temporarily_unavailable",
"message": "This cannot be done right now. Try again in a moment.",
"request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
"retryable": true,
"doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#temporarily_unavailable"
}
}Errors#
Codes this endpoint can return. Match on the code, never on the message.