latestOpenAPI 3.1.02026-08-1848503254.4 KB

e70a96a4b9bb

webhooks

Trigger a group webhook

Trigger all runnable tests in a group from a signed webhook URL.

post/v1/groups/webhook/{webhookId}/{secret}

Path parameters

webhookIdstring uuid required

Webhook ID

secretstring required

Webhook secret

Request body

platform'web' | 'ios' | 'android'

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.

deviceModel'iphone' | 'ipad'

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.

projectEnvironmentIdstring uuid

targetUrlstring uri

environment'production' | 'staging' | 'preview' | 'custom'

commitShastring

Response

Webhook accepted

receivedboolean required

ignoredboolean

reasonstring

runIdstring uuid

batchIdstring uuid

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

batchIdsstring[]

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