Skip to main content
GET
Retrieve a webhook subscription
Coming soon: The Webhooks API is currently under design review. This documentation describes the target interface and may change before release.

Overview

Retrieves a single webhook subscription by its identifier.
Important: the signingSecret is never included in this response. It is only returned when a subscription is created or its secret is rotated.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscriptionId
string<uuid>
required

The unique identifier of the webhook subscription

Response

Webhook subscription successfully retrieved

id
string<uuid>
required

The unique identifier of the subscription.

Example:

"c3d4e5f6-a1b2-4c3d-8e5f-6a7b8c9d0e1f"

url
string<uri>
required

The HTTPS endpoint that will receive the webhook calls.

Example:

"https://partner.example.com/cobee/webhooks"

eventTypes
enum<string>[]
required

The event types this subscription will receive.

Available options:
employee.consumption.registered,
company.payroll-cycle.closed,
employee.committed-expense.requested,
employee.committed-expense.finished,
employee.committed-expense.cancelled,
employee.committed-expense.payment.executed,
employee.committed-expense.payment.cancelled
status
enum<string>
required

The status of the subscription.

Available options:
enabled,
disabled
Example:

"enabled"

createdAt
integer<timestamp>
required

When the subscription was created, in timestamp format.

Example:

1753939051