Description
Summary: Retrieves a single webhook subscription by its ID via the TextPeak API.
Details: This endpoint returns the full details of a specific webhook configured for your account. You must provide the webhook's unique identifier as a path parameter. The response includes the webhook's name, destination URL, trigger type, HTTP method, filter criteria, custom headers, retry configuration, activation status, and creation timestamp. Authentication is performed via a TextPeak API key passed in the Authorization header.
Authentication & Scopes
Authentication is handled via a TextPeak API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the API key.
| Method | Details |
|---|---|
| API Key | Pass your TextPeak API key directly in the Authorization header value. |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Your TextPeak API key that authenticates the request. |
accept | Yes | Must be set to application/json. Indicates that the client expects a JSON response. |
Parameters
This endpoint uses a path parameter to identify the webhook to retrieve.
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
id | integer | Yes | Path | The unique identifier of the webhook to retrieve. |
Request Body
This endpoint does not require a request body.
Examples
This endpoint has a saved example demonstrating usage:
- Get webhook — Retrieving the full details of a specific webhook by its ID.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||