Retrieve the Full Details of a Webhook Subscription

Use this endpoint to retrieve the full details of a single webhook subscription by its ID. The response includes the delivery URL, subscribed event topics, shared secret, and timestamps.

Endpoint

GET https://connect.api-wa.co/project-apis/v1/project/{project_id}/webhook/{webhook_id}

Authentication

X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD

Path Parameters

string

required

Your Convo project ID.

string

required

The unique ID of the webhook subscription you want to retrieve.

Request Example

curl "https://connect.api-wa.co/project-apis/v1/project/YOUR_PROJECT_ID/webhook/627adef5f2d93aba6fa649d7" \
  -H "X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD"

Response

Returns a single webhook object containing the following fields:

string

Unique identifier for the webhook subscription.

string

The ID of the Custom App this webhook is registered under.

string

The ID of the project this webhook belongs to.

array

List of event topics this webhook is subscribed to (e.g., "contact.created", "message.received").

string

The HTTPS URL where event payloads are delivered.

string

A secret token for verifying that incoming payloads originate from Convo. Use this to validate the X-Convo-Signature header on incoming webhook requests.

integer

Unix timestamp (milliseconds) of when the webhook was created.

integer

Unix timestamp (milliseconds) of the last update to this webhook.

Example Response

{
  "id": "627adef5f2d93aba6fa649d7",
  "app_id": "627ac3ce1b6404b276b1acae",
  "project_id": "6245d025fcb7966c46294618",
  "topics": ["contact.created", "message.received"],
  "webhook_url": "https://your-server.com/webhook",
  "shared_secret": "8d008e6e505171aa9c4b5e6f...",
  "created_at": 1652219637153,
  "updated_at": 1652220659065
}

Error Responses

Status Code	Description
`404`	Not Found — No webhook with the given `webhook_id` exists in the specified project.
`500`	Internal Server Error — An unexpected server-side error occurred. Retry the request or contact support.

Overview

Business & Project

Messages

Contacts

Templates

Campaigns

Webhooks

Catalogue

Media

Retrieve the Full Details of a Webhook Subscription

Endpoint

Authentication

Path Parameters

Request Example

Response

Example Response

Error Responses

​Endpoint

​Authentication

​Path Parameters

​Request Example

​Response

​Example Response

​Error Responses

Endpoint

Authentication

Path Parameters

Request Example

Response

Example Response

Error Responses