APapify
Actors/Actor versions

Update Actor version build on push

Changed on

Turns automatic builds on push on or off for an Actor version whose source is a git repository.

Enabling registers a push webhook on the repository through the connected git account given by providerId, so that every push to the repository builds the version. Disabling turns the webhook off on GitHub, or removes it on GitLab and Bitbucket.

You need write access to the Actor. The version must have its source type set to a git repository, and the connected account must have permission to manage the repository's webhooks.

put/v2/actors/{actorId}/versions/{versionNumber}/build-on-push

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Path parameters

actorIdstring required
Example:compass~google-maps-extractor

Actor ID or the username of the Actor owner and the Actor name, separated by a tilde (~).

versionNumberstring required
Example:0.1

Actor version.

Request body

providerIdstring required

The connected git account to register the push webhook through: github-app for the GitHub App, or the ID of a connected GitLab or Bitbucket integration, as returned by the Get git provider integrations endpoint.

enabledboolean required

true registers the push webhook so that pushes to the repository build the version; false turns it off.

Example request

{
  "providerId": "github-app",
  "enabled": true
}

Response

No content

Changes

  • ec76185eb934Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • e52dd2239ceeRevision changes
    • info

      endpoint added