POST/app-manifests/{code}/conversions

Create a GitHub App from a manifest

Creates a GitHub App from a manifest to complete the GitHub App Manifest flow. Use the temporary code to retrieve the app details and credentials, including its id, pem, and webhook_secret.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
codestringrequired
The temporary code returned during the GitHub App Manifest flow, used to retrieve the app details and credentials.

3 status codes
201Returns the created GitHub App object and its credentials, including the app identifier, client ID, client secret, webhook secret, and private key (`pem`).
idintegerrequired
Unique identifier of the GitHub app
slugstringoptional
The slug name of the GitHub app
node_idstringrequired
client_idstringrequired
ownerobjectrequired
A GitHub user.
namestringrequired
The name of the GitHub app
descriptionstringrequired
external_urlstringrequired
html_urlstringrequired
created_atstringrequired
updated_atstringrequired
permissionsobjectrequired
The set of permissions for the GitHub app
eventsarray<string>required
The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
installations_countintegeroptional
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
client_secretstringrequired
webhook_secretstringrequired
pemstringrequired
404Returned when the resource for the supplied code is not found.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when validation fails or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<string>optional

Error handling

A 404 is returned when the resource for the supplied code is not found. A 422 is returned when validation fails or the endpoint has been spammed; the code path parameter must be valid for the manifest conversion.