Skip to main content
POST
Trigger a group webhook

Path Parameters

webhookId
string<uuid>
required

Webhook ID

secret
string
required

Webhook secret

Body

application/json
platform
enum<string>

Run platform for the batch. Mobile tests default to ios when omitted, so Android runs must set platform: android - including when the mobile app is selected by appId or bundleId.

Available options:
web,
ios,
android
deviceModel
enum<string>

Mobile device variant within the run platform (iOS: iphone | ipad). Omit for the platform default phone-sized device; explicitly requesting the default (e.g. iphone) is equivalent to omitting it.

Available options:
iphone,
ipad
projectEnvironmentId
string<uuid>
targetUrl
string<uri>
environment
enum<string>
Available options:
production,
staging,
preview,
custom
mobile
object
commitSha
string

Response

Webhook accepted

received
boolean
required
ignored
boolean
reason
string
runId
string<uuid>
batchId
string<uuid>
deprecated

First created batch only. Use batchIds, which covers every PR test group.

batchIds
string<uuid>[]

One batch per selected PR test group started by this delivery.