action increase_create_an_event_subscription { label: "Create an Event Subscription" provider: increase method: POST path: "/event_subscriptions" encoding: json input: { type: "object" required: ["url"] properties: { selected_event_category: { type: "string" description: "If specified, this subscription will only receive webhooks for Events with the specified `category`." enum: ["account.created", "account.updated", "account_number.created", "account_number.updated", "account_statement.created", "account_transfer.created", "account_transfer.updated", "ach_prenotification.created", "ach_prenotification.updated", "ach_transfer.created", "ach_transfer.updated", "card.created", "card.updated", "card_dispute.created", "card_dispute.updated", "check_deposit.created", "check_deposit.updated", "check_transfer.created", "check_transfer.updated", "declined_transaction.created", "digital_wallet_token.created", "digital_wallet_token.updated", "document.created", "entity.created", "entity.updated", "external_account.created", "file.created", "group.updated", "group.heartbeat", "inbound_ach_transfer_return.created", "inbound_ach_transfer_return.updated", "inbound_wire_drawdown_request.created", "oauth_connection.created", "oauth_connection.deactivated", "pending_transaction.created", "pending_transaction.updated", "real_time_decision.card_authorization_requested", "real_time_decision.digital_wallet_token_requested", "real_time_decision.digital_wallet_authentication_requested", "real_time_payments_transfer.created", "real_time_payments_transfer.updated", "real_time_payments_request_for_payment.created", "real_time_payments_request_for_payment.updated", "transaction.created", "wire_drawdown_request.created", "wire_drawdown_request.updated", "wire_transfer.created", "wire_transfer.updated"] } shared_secret: { type: "string" description: "The key that will be used to sign webhooks. If no value is passed, a random string will be used as default." } url: { type: "string" description: "The URL you'd like us to send webhooks to." } } } output: { type: "object" description: "Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks)." required: ["created_at", "id", "selected_event_category", "shared_secret", "status", "type", "url"] properties: { created_at: { type: "string" format: "date-time" description: "The time the event subscription was created." } id: { type: "string" description: "The event subscription identifier." } selected_event_category: { type: "string" description: "If specified, this subscription will only receive webhooks for Events with the specified `category`." enum: ["account.created", "account.updated", "account_number.created", "account_number.updated", "account_statement.created", "account_transfer.created", "account_transfer.updated", "ach_prenotification.created", "ach_prenotification.updated", "ach_transfer.created", "ach_transfer.updated", "card.created", "card.updated", "card_dispute.created", "card_dispute.updated", "check_deposit.created", "check_deposit.updated", "check_transfer.created", "check_transfer.updated", "declined_transaction.created", "digital_wallet_token.created", "digital_wallet_token.updated", "document.created", "entity.created", "entity.updated", "external_account.created", "file.created", "group.updated", "group.heartbeat", "inbound_ach_transfer_return.created", "inbound_ach_transfer_return.updated", "inbound_wire_drawdown_request.created", "oauth_connection.created", "oauth_connection.deactivated", "pending_transaction.created", "pending_transaction.updated", "real_time_decision.card_authorization_requested", "real_time_decision.digital_wallet_token_requested", "real_time_decision.digital_wallet_authentication_requested", "real_time_payments_transfer.created", "real_time_payments_transfer.updated", "real_time_payments_request_for_payment.created", "real_time_payments_request_for_payment.updated", "transaction.created", "wire_drawdown_request.created", "wire_drawdown_request.updated", "wire_transfer.created", "wire_transfer.updated"] } shared_secret: { type: "string" description: "The key that will be used to sign webhooks." } status: { type: "string" description: "This indicates if we'll send notifications to this subscription." enum: ["active", "disabled", "deleted", "requires_attention"] } type: { type: "string" description: "A constant representing the object's type. For this resource it will always be `event_subscription`." enum: ["event_subscription"] } url: { type: "string" description: "The webhook url where we'll send notifications." } } } }