Appearance
Accept a signed GitHub App webhook ​
This Product operation is available through POST /integrations/github/webhook. Use the reference below to inspect its request contract and documented responses before connecting it to your application.
Request preparation ​
Send a POST request to /integrations/github/webhook on the appropriate server. Check the API overview for base URL guidance and the server information in the interactive reference. Replace path placeholders with identifiers from the intended account or site; a similarly named record in another workspace is not interchangeable.
The declared request parameters are:
X-Hub-Signature-256(header, required): Use the type and constraints shown in the parameter reference.X-GitHub-Delivery(header, required): Use the type and constraints shown in the parameter reference.X-GitHub-Event(header, required): Use the type and constraints shown in the parameter reference.
This operation defines a required request body. Documented media types: application/json. Review required fields, nested objects, and allowed values in the request schema. Keep identifiers and field types intact when replacing example data with your own values.
Authentication and scope ​
This operation does not declare an OpenAPI security requirement. Check the description and parameter definitions for any signed URL, customer identity, webhook, or browser-session conditions before using it outside a test environment.
Keep credentials in the appropriate private configuration and remove secrets from shared logs. Confirm the target resource belongs to the intended workflow before issuing a request. Authentication alone should not be treated as confirmation that a supplied account, site, or customer identifier is correct.
Response handling ​
The documented responses for Accept a signed GitHub App webhook are:
- 202: Delivery durably queued; duplicates are idempotent
- 401: Invalid signature
- 503: Queue or GitHub App unavailable
Exercise this operation with controlled test data before enabling it in an automated workflow. Validate the request against the schema and inspect the response before updating local state. Do not assume that a successful response means background processing has finished; follow any documented status or follow-up operation when the action queues additional work.
If a connection fails after submission, investigate the current server state before repeating an action whose outcome is uncertain. When requesting support, retain the method, route, response status, and sanitized error message. The interactive reference below provides the detailed schemas and examples for this specific operation.
Accept a signed GitHub App webhook​
Powered by VitePress OpenAPI