Skip to content

Area: Developers

GET

Record a webhook open or click (token in the path)

Path
/webhooks/events/{accessToken}
Auth
Access token · in the URL path
GET
/webhooks/events/{accessToken}
curl --request GET \
--url 'https://releva.ai/api/v0/webhooks/events/YOUR_ACCESS_TOKEN?userId=example&webhookId=example&source=webhook&campaignId=example&segmentId=example&segmentRunId=example&status=Open'

Same as GET /webhooks/events, with the access token as the last path segment instead of the authorization header. This is the form used by the webhookOpen and webhookClick URLs in webhook payloads. If an authorization header is also sent, the header is used.

accessToken
required
string format: uuid

The shop’s public access token (UUID). Not the secret key.

Example

YOUR_ACCESS_TOKEN
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."
}