Skip to main content
WEBHOOK

Headers

​
X-Pierre-Event
enum<string>
required

The event type for this delivery.

Available options:
repo.sync.started
​
X-Pierre-Signature
string
required

Signature in the form t=<unix_timestamp>,sha256=<hex_signature>. Verify HMAC-SHA256 with the subscription secret over the timestamp, a period, and the raw request body. Check the timestamp to reject old deliveries.

Body

application/json

The repo.sync.started event payload.

Sent when a repository sync run begins, before the upstream fetch starts. run_count counts previously completed runs.

​
is_first_sync
boolean
required

Whether the repository had never synced successfully before this run began.

​
repository
object
required

The repository that produced the event.

​
run_count
integer<int64>
required

Completed sync runs. For started events, this excludes the current run. For succeeded and failed events, it includes the current run.

​
started_at
string<date-time>
required

When the sync run began, as an RFC 3339 timestamp.

​
type
enum<string>
required

The sync event type. It matches the X-Pierre-Event header.

Available options:
repo.sync.started
​
completed_at
string<date-time>

When the sync run finished, as an RFC 3339 timestamp. Absent on started events.

​
error
string

The failure message. Absent unless the sync failed.

​
lifecycle_id
string

The sync lifecycle ID. It can be absent on older deliveries.

Response

2XX

The receiver accepted the delivery. Return any 2xx status to acknowledge it.