Charity - EventSub Reference | Twitch Developers

Charity Donation

Sends a notification when a user donates to the broadcaster's charity campaign.

Subscription

Type: channel.charity_campaign.donate
Version: 1

Authorization

Requires one of the following:

A user access token that includes the channel:read:charity scope.
An app access token.The application, through prior authorization, must have been granted:
- The channel:read:charity scope for the user represented by the broadcaster_user_id event condition.

Subscription Request Body

typeStringRequired
The event you want to receive notifications about. Must be set to channel.charity_campaign.donate.
versionStringRequired
The subscription type version: 1
conditionObjectRequired
An object that contains subscription-specific parameters.
Hide child attributesShow child attributes
- condition.broadcaster_user_idStringRequired
  The ID of the broadcaster that you want to receive notifications about when users donate to their campaign.
transportObjectRequired
The transport details that you want Twitch to use when sending event notifications.
Hide child attributesShow child attributes
- transport.methodStringRequired
  The transport method for EventSub.
  Possible values
  - webhook
  - websocket
  - conduit
- transport.callbackString
  The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
  
  Specify this field only if method is set to webhook.
  
  NOTE: Redirects are not followed.
- transport.secretString
  The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
  
  Specify this field only if the method is set to webhook.
- transport.session_idString
  An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
  
  Specify this field only if the method is set to websocket.
- transport.conduit_idString
  An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
  
  Specify this field only if the method is set to conduit.

Event Payload

subscriptionObject
Metadata about the subscription.
Hide child attributesShow child attributes
- subscription.idString
  The Subscription ID of the subscription.
- subscription.typeString
  The notification's subscription type.
- subscription.versionString
  The version of the subscription.
- subscription.statusString
  The status of the subscription.
- subscription.costInteger
  How much the subscription counts against your limit. See Subscription Limits for more information.
- subscription.conditionObject
  Subscription-specific parameters.
  Hide child attributesShow child attributes
  - subscription.condition.broadcaster_user_idString
    The ID of the broadcaster that you want to receive notifications about when users donate to their campaign.
- subscription.created_atString
  The time the notification was created.
- subscription.transportObject
  Transport-specific parameters.
  Hide child attributesShow child attributes
  - subscription.transport.methodString
    The transport method for EventSub.
    Possible values
    webhook
    websocket
    conduit
  - subscription.transport.callbackString
    The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
    
    Specify this field only if method is set to webhook.
    
    NOTE: Redirects are not followed.
  - subscription.transport.secretString
    The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
    
    Specify this field only if the method is set to webhook.
  - subscription.transport.session_idString
    An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
    
    Specify this field only if the method is set to websocket.
  - subscription.transport.conduit_idString
    An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
    
    Specify this field only if the method is set to conduit.
eventObject
The event information.
Hide child attributesShow child attributes
- event.idString
  An ID that identifies the donation. The ID is unique across campaigns.
- event.campaign_idString
  An ID that identifies the charity campaign.
- event.broadcaster_user_idString
  An ID that identifies the broadcaster that's running the campaign.
- event.broadcaster_user_loginString
  The broadcaster's login name.
- event.broadcaster_user_nameString
  The broadcaster's display name.
- event.user_idString
  An ID that identifies the user that donated to the campaign.
- event.user_loginString
  The user's login name.
- event.user_nameString
  The user's display name.
- event.charity_nameString
  The charity's name.
- event.charity_descriptionString
  A description of the charity.
- event.charity_logoString
  A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px.
- event.charity_websiteString
  A URL to the charity's website.
- event.amountObject
  An object that contains the amount of money that the user donated.
  Hide child attributesShow child attributes
  - event.amount.valueInteger
    The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.
  - event.amount.decimal_placesInteger
    The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:
    
    value / 10^decimal_places
  - event.amount.currencyString
    The ISO-4217 three-letter currency code that identifies the type of currency in value.

Subscription Request Body Example

{
  "type": "channel.charity_campaign.donate",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "webhook",
    "callback": "https://example.com/webhooks/callback",
    "secret": "s3cRe7"
  }
}

{
  "type": "channel.charity_campaign.donate",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "websocket",
    "session_id": "AQoQexAWVYKSTIu4ec_2VAxyuhAB"
  }
}

{
  "type": "channel.charity_campaign.donate",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "conduit",
    "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac"
  }
}

Event Payload Example

{
  "subscription": {
    "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
    "type": "channel.charity_campaign.donate",
    "version": "1",
    "status": "enabled",
    "cost": 0,
    "condition": {
      "broadcaster_user_id": "123456"
    },
    "transport": {
      "method": "webhook",
      "callback": "https://example.com/webhooks/callback"
    },
    "created_at": "2022-07-25T10:11:12.123Z"
  },
  "event": {
    "id": "a1b2c3-aabb-4455-d1e2f3",
    "campaign_id": "123-abc-456-def",
    "broadcaster_user_id": "123456",
    "broadcaster_user_name": "SunnySideUp",
    "broadcaster_user_login": "sunnysideup",
    "user_id": "654321",
    "user_login": "generoususer1",
    "user_name": "GenerousUser1",
    "charity_name": "Example name",
    "charity_description": "Example description",
    "charity_logo": "https://abc.cloudfront.net/ppgf/1000/100.png",
    "charity_website": "https://www.example.com",
    "amount": {
      "value": 10000,
      "decimal_places": 2,
      "currency": "USD"
    }
  }
}

Charity Campaign Progress

Sends notifications when progress is made towards the campaign's goal or when the broadcaster changes the fundraising goal. It's possible to receive this event before the Start event. To get donation information, subscribe to the channel.charity_campaign.donate event.

Subscription

Type: channel.charity_campaign.progress
Version: 1

Authorization

Requires one of the following:

A user access token that includes the channel:read:charity scope.
An app access token.The application, through prior authorization, must have been granted:
- The channel:read:charity scope for the user represented by the broadcaster_user_id event condition.

Subscription Request Body

typeStringRequired
The event you want to receive notifications about. Must be set to channel.charity_campaign.progress.
versionStringRequired
The definition of the subscription request to use. Must be set to 1.
conditionObjectRequired
An object that contains subscription-specific parameters.
Hide child attributesShow child attributes
- condition.broadcaster_user_idStringRequired
  The ID of the broadcaster that you want to receive notifications about when their campaign makes progress or is updated.
transportObjectRequired
The transport details that you want Twitch to use when sending event notifications.
Hide child attributesShow child attributes
- transport.methodStringRequired
  The transport method for EventSub.
  Possible values
  - webhook
  - websocket
  - conduit
- transport.callbackString
  The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
  
  Specify this field only if method is set to webhook.
  
  NOTE: Redirects are not followed.
- transport.secretString
  The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
  
  Specify this field only if the method is set to webhook.
- transport.session_idString
  An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
  
  Specify this field only if the method is set to websocket.
- transport.conduit_idString
  An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
  
  Specify this field only if the method is set to conduit.

Event Payload

subscriptionObject
Metadata about the subscription.
Hide child attributesShow child attributes
- subscription.idString
  The Subscription ID of the subscription.
- subscription.typeString
  The notification's subscription type.
- subscription.versionString
  The version of the subscription.
- subscription.statusString
  The status of the subscription.
- subscription.costInteger
  How much the subscription counts against your limit. See Subscription Limits for more information.
- subscription.conditionObject
  Subscription-specific parameters.
  Hide child attributesShow child attributes
  - subscription.condition.broadcaster_user_idString
    The ID of the broadcaster that you want to receive notifications about when their campaign makes progress or is updated.
- subscription.created_atString
  The time the notification was created.
- subscription.transportObject
  Transport-specific parameters.
  Hide child attributesShow child attributes
  - subscription.transport.methodString
    The transport method for EventSub.
    Possible values
    webhook
    websocket
    conduit
  - subscription.transport.callbackString
    The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
    
    Specify this field only if method is set to webhook.
    
    NOTE: Redirects are not followed.
  - subscription.transport.secretString
    The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
    
    Specify this field only if the method is set to webhook.
  - subscription.transport.session_idString
    An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
    
    Specify this field only if the method is set to websocket.
  - subscription.transport.conduit_idString
    An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
    
    Specify this field only if the method is set to conduit.
eventObject
The event information.
Hide child attributesShow child attributes
- event.idString
  An ID that identifies the charity campaign.
- event.broadcaster_idString
  An ID that identifies the broadcaster that's running the campaign.
- event.broadcaster_loginString
  The broadcaster's login name.
- event.broadcaster_nameString
  The broadcaster's display name.
- event.charity_nameString
  The charity's name.
- event.charity_descriptionString
  A description of the charity.
- event.charity_logoString
  A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px.
- event.charity_websiteString
  A URL to the charity's website.
- event.current_amountObject
  An object that contains the current amount of donations that the campaign has received.
  Hide child attributesShow child attributes
  - event.current_amount.valueInteger
    The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.
  - event.current_amount.decimal_placesInteger
    The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:
    
    value / 10^decimal_places
  - event.current_amount.currencyString
    The ISO-4217 three-letter currency code that identifies the type of currency in value.
- event.target_amountObject
  An object that contains the campaign's target fundraising goal.
  Hide child attributesShow child attributes
  - event.target_amount.valueInteger
    The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.
  - event.target_amount.decimal_placesInteger
    The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:
    
    value / 10^decimal_places
  - event.target_amount.currencyString
    The ISO-4217 three-letter currency code that identifies the type of currency in value.

Subscription Request Body Example

{
  "type": "channel.charity_campaign.progress",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "webhook",
    "callback": "https://example.com/webhooks/callback",
    "secret": "s3cRe7"
  }
}

{
  "type": "channel.charity_campaign.progress",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "websocket",
    "session_id": "AQoQexAWVYKSTIu4ec_2VAxyuhAB"
  }
}

{
  "type": "channel.charity_campaign.progress",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "conduit",
    "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac"
  }
}

Event Payload Example

{
  "subscription": {
    "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
    "type": "channel.charity_campaign.progress",
    "version": "1",
    "status": "enabled",
    "cost": 0,
    "condition": {
      "broadcaster_user_id": "123456"
    },
    "transport": {
      "method": "webhook",
      "callback": "https://example.com/webhooks/callback"
    },
    "created_at": "2022-07-25T10:11:12.12339824Z"
  },
  "event": {
    "id": "123-abc-456-def",
    "broadcaster_id": "123456",
    "broadcaster_name": "SunnySideUp",
    "broadcaster_login": "sunnysideup",
    "charity_name": "Example name",
    "charity_description": "Example description",
    "charity_logo": "https://abc.cloudfront.net/ppgf/1000/100.png",
    "charity_website": "https://www.example.com",
    "current_amount": {
      "value": 260000,
      "decimal_places": 2,
      "currency": "USD"
    },
    "target_amount": {
      "value": 1500000,
      "decimal_places": 2,
      "currency": "USD"
    }
  }
}

Charity Campaign Start

Sends a notification when the broadcaster starts a charity campaign. It's possible to receive this event after the Progress event.

Subscription

Type: channel.charity_campaign.start
Version: 1

Authorization

Requires one of the following:

A user access token that includes the channel:read:charity scope.
An app access token.The application, through prior authorization, must have been granted:
- The channel:read:charity scope for the user represented by the broadcaster_user_id event condition.

Subscription Request Body

typeStringRequired
The event you want to receive notifications about. Must be set to channel.charity_campaign.start.
versionStringRequired
The definition of the subscription request to use. Must be set to 1.
conditionObjectRequired
An object that contains subscription-specific parameters.
Hide child attributesShow child attributes
- condition.broadcaster_user_idStringRequired
  The ID of the broadcaster that you want to receive notifications about when they start a charity campaign.
transportObjectRequired
The transport details that you want Twitch to use when sending event notifications.
Hide child attributesShow child attributes
- transport.methodStringRequired
  The transport method for EventSub.
  Possible values
  - webhook
  - websocket
  - conduit
- transport.callbackString
  The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
  
  Specify this field only if method is set to webhook.
  
  NOTE: Redirects are not followed.
- transport.secretString
  The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
  
  Specify this field only if the method is set to webhook.
- transport.session_idString
  An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
  
  Specify this field only if the method is set to websocket.
- transport.conduit_idString
  An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
  
  Specify this field only if the method is set to conduit.

Event Payload

subscriptionObject
Metadata about the subscription.
Hide child attributesShow child attributes
- subscription.idString
  The Subscription ID of the subscription.
- subscription.typeString
  The notification's subscription type.
- subscription.versionString
  The version of the subscription.
- subscription.statusString
  The status of the subscription.
- subscription.costInteger
  How much the subscription counts against your limit. See Subscription Limits for more information.
- subscription.conditionObject
  Subscription-specific parameters.
  Hide child attributesShow child attributes
  - subscription.condition.broadcaster_user_idString
    The ID of the broadcaster that you want to receive notifications about when they start a charity campaign.
- subscription.created_atString
  The time the notification was created.
- subscription.transportObject
  Transport-specific parameters.
  Hide child attributesShow child attributes
  - subscription.transport.methodString
    The transport method for EventSub.
    Possible values
    webhook
    websocket
    conduit
  - subscription.transport.callbackString
    The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
    
    Specify this field only if method is set to webhook.
    
    NOTE: Redirects are not followed.
  - subscription.transport.secretString
    The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
    
    Specify this field only if the method is set to webhook.
  - subscription.transport.session_idString
    An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
    
    Specify this field only if the method is set to websocket.
  - subscription.transport.conduit_idString
    An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
    
    Specify this field only if the method is set to conduit.
eventObject
The event information.
Hide child attributesShow child attributes
- event.idString
  An ID that identifies the charity campaign.
- event.broadcaster_idString
  An ID that identifies the broadcaster that's running the campaign.
- event.broadcaster_loginString
  The broadcaster's login name.
- event.broadcaster_nameString
  The broadcaster's display name.
- event.charity_nameString
  The charity's name.
- event.charity_descriptionString
  A description of the charity.
- event.charity_logoString
  A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px.
- event.charity_websiteString
  A URL to the charity's website.
- event.current_amountObject
  An object that contains the current amount of donations that the campaign has received.
  Hide child attributesShow child attributes
  - event.current_amount.valueInteger
    The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.
  - event.current_amount.decimal_placesInteger
    The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:
    
    value / 10^decimal_places
  - event.current_amount.currencyString
    The ISO-4217 three-letter currency code that identifies the type of currency in value.
- event.target_amountObject
  An object that contains the campaign's target fundraising goal.
  Hide child attributesShow child attributes
  - event.target_amount.valueInteger
    The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.
  - event.target_amount.decimal_placesInteger
    The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:
    
    value / 10^decimal_places
  - event.target_amount.currencyString
    The ISO-4217 three-letter currency code that identifies the type of currency in value.
- event.started_atString
  The UTC timestamp (in RFC3339 format) of when the broadcaster started the campaign.

Subscription Request Body Example

{
  "type": "channel.charity_campaign.start",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "webhook",
    "callback": "https://example.com/webhooks/callback",
    "secret": "s3cRe7"
  }
}

{
  "type": "channel.charity_campaign.start",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "websocket",
    "session_id": "AQoQexAWVYKSTIu4ec_2VAxyuhAB"
  }
}

{
  "type": "channel.charity_campaign.start",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "conduit",
    "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac"
  }
}

Event Payload Example

{
  "subscription": {
    "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
    "type": "channel.charity_campaign.start",
    "version": "1",
    "status": "enabled",
    "cost": 0,
    "condition": {
      "broadcaster_user_id": "123456"
    },
    "transport": {
      "method": "webhook",
      "callback": "https://example.com/webhooks/callback"
    },
    "created_at": "2022-07-25T10:11:12.12339824Z"
  },
  "event": {
    "id": "123-abc-456-def",
    "broadcaster_id": "123456",
    "broadcaster_name": "SunnySideUp",
    "broadcaster_login": "sunnysideup",
    "charity_name": "Example name",
    "charity_description": "Example description",
    "charity_logo": "https://abc.cloudfront.net/ppgf/1000/100.png",
    "charity_website": "https://www.example.com",
    "current_amount": {
      "value": 0,
      "decimal_places": 2,
      "currency": "USD"
    },
    "target_amount": {
      "value": 1500000,
      "decimal_places": 2,
      "currency": "USD"
    },
    "started_at": "2022-07-26T17:00:03.17106713Z"
  }
}

Charity Campaign Stop

Sends a notification when the broadcaster stops a charity campaign.

Subscription

Type: channel.charity_campaign.stop
Version: 1

Authorization

Requires one of the following:

A user access token that includes the channel:read:charity scope.
An app access token.The application, through prior authorization, must have been granted:
- The channel:read:charity scope for the user represented by the broadcaster_user_id event condition.

Subscription Request Body

typeStringRequired
The event you want to receive notifications about. Must be set to channel.charity_campaign.stop.
versionStringRequired
The definition of the subscription request to use. Must be set to 1.
conditionObjectRequired
An object that contains subscription-specific parameters.
Hide child attributesShow child attributes
- condition.broadcaster_user_idStringRequired
  The ID of the broadcaster that you want to receive notifications about when they stop a charity campaign.
transportObjectRequired
The transport details that you want Twitch to use when sending event notifications.
Hide child attributesShow child attributes
- transport.methodStringRequired
  The transport method for EventSub.
  Possible values
  - webhook
  - websocket
  - conduit
- transport.callbackString
  The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
  
  Specify this field only if method is set to webhook.
  
  NOTE: Redirects are not followed.
- transport.secretString
  The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
  
  Specify this field only if the method is set to webhook.
- transport.session_idString
  An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
  
  Specify this field only if the method is set to websocket.
- transport.conduit_idString
  An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
  
  Specify this field only if the method is set to conduit.

Event Payload

subscriptionObject
Metadata about the subscription.
Hide child attributesShow child attributes
- subscription.idString
  The Subscription ID of the subscription.
- subscription.typeString
  The notification's subscription type.
- subscription.versionString
  The version of the subscription.
- subscription.statusString
  The status of the subscription.
- subscription.costInteger
  How much the subscription counts against your limit. See Subscription Limits for more information.
- subscription.conditionObject
  Subscription-specific parameters.
  Hide child attributesShow child attributes
  - subscription.condition.broadcaster_user_idString
    The ID of the broadcaster that you want to receive notifications about when they stop a charity campaign.
- subscription.created_atString
  The time the notification was created.
- subscription.transportObject
  Transport-specific parameters.
  Hide child attributesShow child attributes
  - subscription.transport.methodString
    The transport method for EventSub.
    Possible values
    webhook
    websocket
    conduit
  - subscription.transport.callbackString
    The callback URL where notifications are sent. The URL must use the HTTPS protocol and port 443. See Processing an Event.
    
    Specify this field only if method is set to webhook.
    
    NOTE: Redirects are not followed.
  - subscription.transport.secretString
    The secret used to verify the signature. The secret must be an ASCII string that's a minimum of 10 characters long and a maximum of 100 characters long. For information about how the secret is used, see Verifying the event message.
    
    Specify this field only if the method is set to webhook.
  - subscription.transport.session_idString
    An ID that identifies the WebSocket to send notifications to. When you connect to EventSub using WebSockets, the server returns the ID in the Welcome message.
    
    Specify this field only if the method is set to websocket.
  - subscription.transport.conduit_idString
    An ID that identifies the conduit to send this notification to. When you create a conduit, the server returns the ID in the API response.
    
    Specify this field only if the method is set to conduit.
eventObject
The event information.
Hide child attributesShow child attributes
- event.idString
  An ID that identifies the charity campaign.
- event.broadcaster_idString
  An ID that identifies the broadcaster that ran the campaign.
- event.broadcaster_loginString
  The broadcaster's login name.
- event.broadcaster_nameString
  The broadcaster's display name.
- event.charity_nameString
  The charity's name.
- event.charity_descriptionString
  A description of the charity.
- event.charity_logoString
  A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px.
- event.charity_websiteString
  A URL to the charity's website.
- event.current_amountObject
  An object that contains the final amount of donations that the campaign received.
  Hide child attributesShow child attributes
  - event.current_amount.valueInteger
    The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.
  - event.current_amount.decimal_placesInteger
    The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:
    
    value / 10^decimal_places
  - event.current_amount.currencyString
    The ISO-4217 three-letter currency code that identifies the type of currency in value.
- event.target_amountObject
  An object that contains the campaign's target fundraising goal.
  Hide child attributesShow child attributes
  - event.target_amount.valueInteger
    The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.
  - event.target_amount.decimal_placesInteger
    The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:
    
    value / 10^decimal_places
  - event.target_amount.currencyString
    The ISO-4217 three-letter currency code that identifies the type of currency in value.
- event.stopped_atString
  The UTC timestamp (in RFC3339 format) of when the broadcaster stopped the campaign.

Subscription Request Body Example

{
  "type": "channel.charity_campaign.stop",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "webhook",
    "callback": "https://example.com/webhooks/callback",
    "secret": "s3cRe7"
  }
}

{
  "type": "channel.charity_campaign.stop",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "websocket",
    "session_id": "AQoQexAWVYKSTIu4ec_2VAxyuhAB"
  }
}

{
  "type": "channel.charity_campaign.stop",
  "version": "1",
  "condition": {
    "broadcaster_user_id": "123456"
  },
  "transport": {
    "method": "conduit",
    "conduit_id": "bfcfc993-26b1-b876-44d9-afe75a379dac"
  }
}

Event Payload Example

{
  "subscription": {
    "id": "f1c2a387-161a-49f9-a165-0f21d7a4e1c4",
    "type": "channel.charity_campaign.stop",
    "version": "1",
    "status": "enabled",
    "cost": 0,
    "condition": {
      "broadcaster_user_id": "123456"
    },
    "transport": {
      "method": "webhook",
      "callback": "https://example.com/webhooks/callback"
    },
    "created_at": "2022-07-25T10:11:12.12339824Z"
  },
  "event": {
    "id": "123-abc-456-def",
    "broadcaster_id": "123456",
    "broadcaster_name": "SunnySideUp",
    "broadcaster_login": "sunnysideup",
    "charity_name": "Example name",
    "charity_description": "Example description",
    "charity_logo": "https://abc.cloudfront.net/ppgf/1000/100.png",
    "charity_website": "https://www.example.com",
    "current_amount": {
      "value": 1450000,
      "decimal_places": 2,
      "currency": "USD"
    },
    "target_amount": {
      "value": 1500000,
      "decimal_places": 2,
      "currency": "USD"
    },
    "stopped_at": "2022-07-26T22:00:03.17106713Z"
  }
}