Conduit

Conduit Shard Disabled

Subscription

Type

conduit.shard.disabled

Version

1

Authorization

Requires one of the following:

• An app access token.The Client ID of the token used must match the Client ID in the condition. If conduit_id is specified, the client must be the owner of the conduit.

Subscription Request Body

• typeStringRequired
  The subscription type name: conduit.shard.disabled.
• versionStringRequired
  The subscription type version: 1.
• conditionObjectRequired
  Subscription-specific parameters. Optionally pass in the conduit ID for the conduit you want to receive events for.
  Hide child attributesShow child attributes

  • condition.client_idStringRequired
    Your application's client id. The provided client_id must match the client ID in the application access token.
  • condition.conduit_idString
    The conduit ID to receive events for. If omitted, events for all of this client's conduits are sent.
• transportObjectRequired
  Transport-specific parameters.
  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.client_idString
      Your application's client id. The provided client_id must match the client ID in the application access token.
    • subscription.condition.conduit_idString
      The conduit ID to receive events for. If omitted, events for all of this client's conduits are sent.
  • 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.conduit_idString
    The ID of the conduit.
  • event.shard_idString
    The ID of the disabled shard.
  • event.statusString
    The new status of the transport.
  • event.transportObject
    The disabled transport.
    Hide child attributesShow child attributes

    • event.transport.methodString
      websocket or webhook
    • event.transport.callbackStringNullable
      Webhook callback URL. Null if method is set to websocket.
    • event.transport.session_idStringNullable
      WebSocket session ID. Null if method is set to webhook.
    • event.transport.connected_atStringNullable
      Time that the WebSocket session connected. Null if method is set to webhook.
    • event.transport.disconnected_atStringNullable
      Time that the WebSocket session disconnected. Null if method is set to webhook.