--- title: "Create an Event Subscription" method: POST path: "/event_subscriptions" --- # Create an Event Subscription `POST /event_subscriptions` ## Request body - CreateAnEventSubscriptionParameters - `oauth_connection_id` string — If specified, this subscription will only receive webhooks for Events associated with the specified OAuth Connection. - `selected_event_categories` object[] — If specified, this subscription will only receive webhooks for Events with the specified `category`. If specifying a Real-Time Decision event category, only one Event Category can be specified for the Event Subscription. - `event_category` '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' | 'blockchain_address.created' | 'blockchain_address.updated' | 'blockchain_offramp_transfer.created' | 'blockchain_offramp_transfer.updated' | 'blockchain_onramp_transfer.created' | 'blockchain_onramp_transfer.updated' | 'bookkeeping_account.created' | 'bookkeeping_account.updated' | 'bookkeeping_entry_set.updated' | 'card.created' | 'card.updated' | 'card_payment.created' | 'card_payment.updated' | 'card_purchase_supplement.created' | 'card_profile.created' | 'card_profile.updated' | 'card_dispute.created' | 'card_dispute.updated' | 'check_deposit.created' | 'check_deposit.updated' | 'check_transfer.created' | 'check_transfer.updated' | 'declined_transaction.created' | 'digital_card_profile.created' | 'digital_card_profile.updated' | 'digital_wallet_token.created' | 'digital_wallet_token.updated' | 'entity.created' | 'entity.updated' | 'event_subscription.created' | 'event_subscription.updated' | 'export.created' | 'export.updated' | 'external_account.created' | 'external_account.updated' | 'fednow_transfer.created' | 'fednow_transfer.updated' | 'file.created' | 'group.updated' | 'group.heartbeat' | 'inbound_ach_transfer.created' | 'inbound_ach_transfer.updated' | 'inbound_ach_transfer_return.created' | 'inbound_ach_transfer_return.updated' | 'inbound_check_deposit.created' | 'inbound_check_deposit.updated' | 'inbound_fednow_transfer.created' | 'inbound_fednow_transfer.updated' | 'inbound_mail_item.created' | 'inbound_mail_item.updated' | 'inbound_real_time_payments_transfer.created' | 'inbound_real_time_payments_transfer.updated' | 'inbound_wire_drawdown_request.created' | 'inbound_wire_transfer.created' | 'inbound_wire_transfer.updated' | 'intrafi_account_enrollment.created' | 'intrafi_account_enrollment.updated' | 'intrafi_exclusion.created' | 'intrafi_exclusion.updated' | 'lockbox.created' | 'lockbox.updated' | 'oauth_connection.created' | 'oauth_connection.deactivated' | 'card_push_transfer.created' | 'card_push_transfer.updated' | 'card_validation.created' | 'card_validation.updated' | 'pending_transaction.created' | 'pending_transaction.updated' | 'physical_card.created' | 'physical_card.updated' | 'physical_card_profile.created' | 'physical_card_profile.updated' | 'physical_check.created' | 'physical_check.updated' | 'program.created' | 'program.updated' | 'proof_of_authorization_request.created' | 'proof_of_authorization_request.updated' | 'real_time_decision.card_authorization_requested' | 'real_time_decision.card_balance_inquiry_requested' | 'real_time_decision.digital_wallet_token_requested' | 'real_time_decision.digital_wallet_authentication_requested' | 'real_time_decision.card_authentication_requested' | 'real_time_decision.card_authentication_challenge_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' | 'swift_transfer.created' | 'swift_transfer.updated' | 'transaction.created' | 'wire_drawdown_request.created' | 'wire_drawdown_request.updated' | 'wire_transfer.created' | 'wire_transfer.updated', required — The category of the Event to subscribe to. - `shared_secret` string — The key that will be used to sign webhooks. If no value is passed, a random string will be used as default. - `status` 'active' | 'disabled' — The status of the event subscription. Defaults to `active` if not specified. - `url` string, required — The URL you'd like us to send webhooks to. ## Response `200` Event Subscription - EventSubscription — 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). - `created_at` string, date-time, required — The time the event subscription was created. - `id` string, required — The event subscription identifier. - `idempotency_key` string, nullable, required — The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). - `oauth_connection_id` string, nullable, required — If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection. - `selected_event_categories` object[], nullable, required — If specified, this subscription will only receive webhooks for Events with the specified `category`. - `event_category` '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' | 'blockchain_address.created' | 'blockchain_address.updated' | 'blockchain_offramp_transfer.created' | 'blockchain_offramp_transfer.updated' | 'blockchain_onramp_transfer.created' | 'blockchain_onramp_transfer.updated' | 'bookkeeping_account.created' | 'bookkeeping_account.updated' | 'bookkeeping_entry_set.updated' | 'card.created' | 'card.updated' | 'card_payment.created' | 'card_payment.updated' | 'card_purchase_supplement.created' | 'card_profile.created' | 'card_profile.updated' | 'card_dispute.created' | 'card_dispute.updated' | 'check_deposit.created' | 'check_deposit.updated' | 'check_transfer.created' | 'check_transfer.updated' | 'declined_transaction.created' | 'digital_card_profile.created' | 'digital_card_profile.updated' | 'digital_wallet_token.created' | 'digital_wallet_token.updated' | 'entity.created' | 'entity.updated' | 'event_subscription.created' | 'event_subscription.updated' | 'export.created' | 'export.updated' | 'external_account.created' | 'external_account.updated' | 'fednow_transfer.created' | 'fednow_transfer.updated' | 'file.created' | 'group.updated' | 'group.heartbeat' | 'inbound_ach_transfer.created' | 'inbound_ach_transfer.updated' | 'inbound_ach_transfer_return.created' | 'inbound_ach_transfer_return.updated' | 'inbound_check_deposit.created' | 'inbound_check_deposit.updated' | 'inbound_fednow_transfer.created' | 'inbound_fednow_transfer.updated' | 'inbound_mail_item.created' | 'inbound_mail_item.updated' | 'inbound_real_time_payments_transfer.created' | 'inbound_real_time_payments_transfer.updated' | 'inbound_wire_drawdown_request.created' | 'inbound_wire_transfer.created' | 'inbound_wire_transfer.updated' | 'intrafi_account_enrollment.created' | 'intrafi_account_enrollment.updated' | 'intrafi_exclusion.created' | 'intrafi_exclusion.updated' | 'lockbox.created' | 'lockbox.updated' | 'oauth_connection.created' | 'oauth_connection.deactivated' | 'card_push_transfer.created' | 'card_push_transfer.updated' | 'card_validation.created' | 'card_validation.updated' | 'pending_transaction.created' | 'pending_transaction.updated' | 'physical_card.created' | 'physical_card.updated' | 'physical_card_profile.created' | 'physical_card_profile.updated' | 'physical_check.created' | 'physical_check.updated' | 'program.created' | 'program.updated' | 'proof_of_authorization_request.created' | 'proof_of_authorization_request.updated' | 'real_time_decision.card_authorization_requested' | 'real_time_decision.card_balance_inquiry_requested' | 'real_time_decision.digital_wallet_token_requested' | 'real_time_decision.digital_wallet_authentication_requested' | 'real_time_decision.card_authentication_requested' | 'real_time_decision.card_authentication_challenge_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' | 'swift_transfer.created' | 'swift_transfer.updated' | 'transaction.created' | 'wire_drawdown_request.created' | 'wire_drawdown_request.updated' | 'wire_transfer.created' | 'wire_transfer.updated', nullable, required — The category of the Event. - `status` 'active' | 'disabled' | 'deleted' | 'requires_attention', required — This indicates if we'll send notifications to this subscription. - `type` 'event_subscription', required — A constant representing the object's type. For this resource it will always be `event_subscription`. - `url` string, required — The webhook url where we'll send notifications. ## Other responses - `4XX` — Error - `5XX` — Error --- [API](https://skmtc.net/increase/apis/increase-api.md) · [All operations](https://skmtc.net/increase/apis/increase-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api/versions/22125d715935/schema)