Skip to main content
PATCH
TypeScript

Authorizations

Authorization
string
header
required

Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.

Path Parameters

projectId
string
required

The project the webhook belongs to.

endpointId
string
required

The unique identifier of the webhook to update.

Body

application/json

Fields to update. All fields are optional.

Webhook fields to replace; omitted fields remain unchanged.

enabled
boolean

Whether Signal should attempt new deliveries to this endpoint.

events
enum<string>[]

Replacement event subscription list.

Available options:
email.sent,
email.delivered,
email.bounced,
email.complained,
email.opened,
email.clicked,
email.failed,
email.rejected,
email.delivery_delayed,
email.suppressed,
email.unsubscribed,
email.read_engaged,
webhook.test
filters
WebhookFilterSerializable · object[]

Replacement filter list.

name
string

Replacement endpoint name.

secret
string

Replacement signing secret used for subsequent deliveries.

transformations
WebhookTransformationSerializable · object[]

Replacement ordered transformation list.

url
string<uri>

Replacement public HTTPS delivery URL.

Response

Updated webhook endpoint.

createdAt
string
required
enabled
boolean
required
events
string[]
required
id
string
required
name
string
required
projectId
string
required
updatedAt
string
required
url
string
required
filters
WebhookFilterSerializable · object[]
transformations
WebhookTransformationSerializable · object[]