Skip to main content
Version: Next

APIAuditLogOptions

Index

Properties

optionalauto_moderation_rule_name

auto_moderation_rule_name?: string

Name of the Auto Moderation rule that was triggered

Present from:

  • AUTO_MODERATION_BLOCK_MESSAGE
  • AUTO_MODERATION_FLAG_TO_CHANNEL
  • AUTO_MODERATION_USER_COMMUNICATION_DISABLED

optionalauto_moderation_rule_trigger_type

auto_moderation_rule_trigger_type?: 1 | 3 | 4 | 5

Trigger type of the Auto Moderation rule that was triggered

Present from:

  • AUTO_MODERATION_BLOCK_MESSAGE
  • AUTO_MODERATION_FLAG_TO_CHANNEL
  • AUTO_MODERATION_USER_COMMUNICATION_DISABLED

optionalchannel_id

channel_id?: string

Channel in which the entities were targeted

Present from:

  • MEMBER_MOVE
  • MESSAGE_PIN
  • MESSAGE_UNPIN
  • MESSAGE_DELETE
  • STAGE_INSTANCE_CREATE
  • STAGE_INSTANCE_UPDATE
  • STAGE_INSTANCE_DELETE
  • AUTO_MODERATION_BLOCK_MESSAGE
  • AUTO_MODERATION_FLAG_TO_CHANNEL
  • AUTO_MODERATION_USER_COMMUNICATION_DISABLED

optionalcount

count?: string

Number of entities that were targeted

Present from:

  • MESSAGE_DELETE
  • MESSAGE_BULK_DELETE
  • MEMBER_DISCONNECT
  • MEMBER_MOVE

optionaldelete_member_days

delete_member_days?: string

Number of days after which inactive members were kicked

Present from:

  • MEMBER_PRUNE

optionalid

id?: string

ID of the overwritten entity

Present from:

  • CHANNEL_OVERWRITE_CREATE
  • CHANNEL_OVERWRITE_UPDATE
  • CHANNEL_OVERWRITE_DELETE

optionalintegration_type

integration_type?: APIGuildIntegrationType

Type of integration which performed the action

Present from:

  • MEMBER_KICK
  • MEMBER_ROLE_UPDATE

optionalmembers_removed

members_removed?: string

Number of members removed by the prune

Present from:

  • MEMBER_PRUNE

optionalmessage_id

message_id?: string

ID of the message that was targeted

Present from:

  • MESSAGE_PIN
  • MESSAGE_UNPIN

optionalrole_name

role_name?: string

Name of the role

Present from:

  • CHANNEL_OVERWRITE_CREATE
  • CHANNEL_OVERWRITE_UPDATE
  • CHANNEL_OVERWRITE_DELETE

Present only if the entry type is “0”

optionaltype

Type of overwritten entity - “0” for “role” or “1” for “member”

Present from:

  • CHANNEL_OVERWRITE_CREATE
  • CHANNEL_OVERWRITE_UPDATE
  • CHANNEL_OVERWRITE_DELETE

AuditLogOptionsType