Skip to content

Area: Developers

GET

Record a webhook open or click

Path
/webhooks/events
Auth
Access token · browser or app
GET
/webhooks/events
curl --request GET \
--url 'https://releva.ai/api/v0/webhooks/events?userId=example&webhookId=example&source=webhook&campaignId=example&segmentId=example&segmentRunId=example&status=Open' \
--header 'Authorization: Bearer <token>'

Records that a profile opened or clicked what your system sent after receiving a Releva webhook. Each profile in a webhook payload carries ready-made webhookOpen and webhookClick URLs that call this endpoint with the access token in the path; call them as they are rather than building the URL yourself. Writes a webhookOpen or webhookClick event and attributes the profile to the workflow and step, so later purchases count as assisted. Processing is asynchronous and every call writes another event (no deduplication). A status other than Open or Click, or a campaignId that is not a numeric workflow id, is accepted with 202 but nothing is recorded. Works even when the shop is disabled.

userId
required
string

Your customer id for the profile (the part after profile/<domainId>/ in profileId).

webhookId
required
string

Id of the webhook. Not checked to exist.

source
required
string
Allowed values: webhook
campaignId
required
string

Numeric id of the workflow. An empty or non-numeric value is accepted with 202 but nothing is recorded.

segmentId
required
string

Id of the workflow’s segment. May be empty.

segmentRunId
required
string

The workflow execution (source.segmentRunId of the payload). May be empty.

flowStepId
string

The workflow step (source.flowStepId of the payload). Used for step attribution.

status
required
string
Allowed values: Open Click

Open records webhookOpen, Click records webhookClick. Case-sensitive; any other value is accepted and ignored.

email
string format: email

Validated when not empty, otherwise ignored.

Accepted for asynchronous processing. Empty body.

Authentication or validation error. Several validation messages are joined with a space.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "The 'userId' field is required. The 'source' field is required. The 'campaignId' field is required. The 'segmentId' field is required. The 'segmentRunId' field is required. The 'status' field is required. The 'webhookId' field is required."
}

Unexpected server error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}