Webhooks

Trigger a group webhook

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

Path parameters

webhookIdstringRequiredformat: "uuid"
Webhook ID
secretstringRequired
Webhook secret

Request

This endpoint expects an object.
platformenumOptional

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.

Allowed values:
deviceModelenumOptional

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.

Allowed values:
projectEnvironmentIdstringOptionalformat: "uuid"
targetUrlstringOptionalformat: "uri"
environmentenumOptional
Allowed values:
mobileobjectOptional
commitShastringOptional

Response

Webhook accepted
receivedboolean
ignoredbooleanOptional
reasonstringOptional
runIdstringOptionalformat: "uuid"
batchIdslist of stringsOptional
One batch per selected PR test group started by this delivery.
batchIdstringOptionalformat: "uuid"Deprecated
First created batch only. Use batchIds, which covers every PR test group.

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error