Skip to content

Commit 7647631

Browse files
GhadimiRCopilotCopilotmchammer01
authored
Document ghost user as a possible webhook sender (#62336)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Copilot-Session: 77b18c9c-f6c9-40bb-bf4c-64de09b1e7f1
1 parent 608fbdc commit 7647631

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

content/webhooks/webhook-events-and-payloads.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Each webhook event on this page includes a description of the webhook properties
2727

2828
Each event is only available to specific types of webhooks. For example, an organization webhook can subscribe to the `team` event, but a repository webhook cannot. The description of each webhook event lists the availability for that event. For more information, see [AUTOTITLE](/webhooks/types-of-webhooks).
2929

30+
### The `sender` property
31+
32+
Most webhook payloads include a `sender` property identifying the user who triggered the event. Sometimes {% data variables.product.github %} can't resolve a specific user, for example when an event comes from an internal process rather than a person, or when the triggering action has no associated user. For some events, such as `check_run` and `check_suite`, this includes actions with no Git push or authenticated API actor.
33+
34+
In these cases, `sender` is populated with the [`ghost` user](https://github.com/ghost), a placeholder account whose `login` is `ghost` and whose `id` isn't tied to a real, current user. Don't assume `sender` always identifies the person who caused an event, and account for the `ghost` user in any security or business logic that relies on it.
35+
3036
### Payload cap
3137

3238
{% data reusables.webhooks.payload_cap %}

0 commit comments

Comments
 (0)