Get an Event Subscription

GET /groups/{groupId}/apps/{appId}/event_subscriptions/{eventSubscriptionId}

Token auth

Return information about an event subscription.

Path parameters

groupId string Required

An Atlas Project/Group ID.
appId string Required

The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
eventSubscriptionId string Required

The unique _id value of an event subscription.

Responses

200 application/json

Success.
A subscription to a change event stream.
One of:
DatabaseTrigger object AuthenticationTrigger object ScheduledTrigger object EventSubscription object
Hide attributes Show attributes

_id string

The trigger's unique ID.

name string Required

The trigger's name.

type string Required

The trigger type. For database triggers, this value is always "DATABASE".

Value is DATABASE.

disabled boolean

If true, the trigger is disabled and does not listen for events or execute.

Default value is false.

config object Required

An object that defines configuration values for the trigger.

Hide config attributes Show config attributes object

service_id string Required

The _id value of a linked MongoDB data source that contains the watched collection.

You can list services with the Get all services endpoint.

Data sources are services whose type is "mongodb-atlas". Use the _id value for the data source you want to link to the Trigger.

database string

The name of a database in the linked data source. If you omit this parameter, the Source Type changes to "Deployment." However, shared tier infrastructure does not support deployment changestreams. If you omit the 'database' parameter, you receive the 'deployment changestreams are not supported on shared tier clusters' error. Supply the database parameter to resolve this error.

collection string

The name of a collection in the specified database. The trigger listens to events from this collection. If you omit this parameter, the Source Type changes to "Database."

operation_types array[string] Required

The types of MongoDB change event that the trigger listens for.

Valid operation types for all triggers include:

"INSERT"

"UPDATE"

"REPLACE"

"DELETE"

Additional valid operation types for database and deployment triggers include:

"CREATE_COLLECTION"

"MODIFY_COLLECTION"

"RENAME_COLLECTION"

"DROP_COLLECTION"

"SHARD_COLLECTION"

"RESHARD_COLLECTION"

"REFINE_COLLECTION_SHARD_KEY"

Additional valid operation types for deployment triggers include:

"DROP_DATABASE"

For more information, refer to Trigger Configuration.

At least 1 element.

match object

A $match expression filters change events. The trigger will only fire if the expression evaluates to true for a given change event.

project object

A $project expression returns only the specified fields. You can include or exclude specific fields, or include newly-computed fields.

full_document boolean

If true, indicates that UPDATE change events should include the most current majority-committed version of the modified document in the fullDocument field.

Default value is false.

full_document_before_change boolean

If true, indicates that UPDATE change events should include a snapshot of the modified document from immediately before the update was applied.

You must enable document preimages for your cluster to include these snapshots.

Default value is false.

skip_catchup_events boolean

If true, enabling the Trigger after it was disabled will not invoke events that occurred while the Trigger was disabled.

Default value is false.

tolerate_resume_errors boolean

If true, when this Trigger's resume token cannot be found in the cluster's oplog, the Trigger automatically resumes processing events at the next relevant change stream event. All change stream events from when the Trigger was suspended until the Trigger resumes execution do not have the Trigger fire for them.

Default value is false.

maximum_throughput boolean

If true, the trigger will use the maximize throughput option.

Default value is false.

unordered boolean

If true, event ordering is disabled and this Trigger can process events in parallel. If false, event ordering is enabled and the Trigger executes events serially.

Default value is false.

function_id string

The ID of the function that the trigger calls when it fires.

This value is the same as event_processors.FUNCTION.function_id. You can either define the value here or in event_processors.FUNCTION.function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define function_id, the backend duplicates it to event_processors.FUNCTION.function_id.

If you define function_id, event_processors is not required. You must provide either function_id or event_processors when updating a trigger.

function_name string

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as event_processors.FUNCTION.function_name. You can either define the value here or in event_processors.FUNCTION.function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define function_name, the backend duplicates it to event_processors.FUNCTION.function_name.

If you define function_name, event_processors is not required. You must provide either function_name or event_processors when updating a trigger.

event_processors object Required

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. For an example configuration object, see Send Trigger Events to AWS EventBridge.

Hide event_processors attributes Show event_processors attributes object

FUNCTION object

Hide FUNCTION attribute Show FUNCTION attribute object

config object

Hide config attributes Show config attributes object

function_id string

The ID of the function that the trigger calls when it fires.

This value is the same as the root-level function_id. You can either define the value here or in function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_id, the backend duplicates it to function_id.

If you define function_id, event_processors is not required. You must provide either function_id or event_processors when updating a trigger.

function_name string

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as the root-level function_name. You can either define the value here or in function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_name, the backend duplicates it to function_name.

If you define function_name, event_processors is not required. You must provide either function_name or event_processors when updating a trigger.

AWS_EVENTBRIDGE object

Hide AWS_EVENTBRIDGE attribute Show AWS_EVENTBRIDGE attribute object

config object

Hide config attributes Show config attributes object

account_id string

An AWS Account ID.

region string

An AWS region.

extended_json_enabled boolean

If true, event objects are serialized using EJSON.

Default value is false.

error_handler object

An object that defines custom error handling for an AWS EventBridge trigger. Valid only for "DATABASE" type triggers with "AWS_EVENTBRIDGE" event processors.

Hide error_handler attribute Show error_handler attribute object

config object

Hide config attributes Show config attributes object

enabled boolean

If 'true', custom error handling is enabled for the AWS EventBridge trigger.

function_id string

The ID of the function invoked when the AWS EventBridge trigger fails and cannot be successfully retried.
Hide attributes Show attributes

_id string

The trigger's unique ID.

name string Required

The trigger's name.

type string Required

The trigger type. For authentication triggers, this value is always "AUTHENTICATION".

Value is AUTHENTICATION.

disabled boolean

If true, the trigger is disabled and does not listen for events or execute.

Default value is false.

config object Required

An object that defines configuration values for the trigger.

Hide config attributes Show config attributes object

operation_type string Required

The type of authentication event that the trigger listens for.

Values are LOGIN, CREATE, or DELETE.

providers string Required

The type(s) of authentication provider that the trigger listens to.

Values are anon-user, api-key, custom-token, custom-function, local-userpass, oauth2-apple, oauth2-facebook, or oauth2-google.

function_id string

The ID of the function that the trigger calls when it fires.

This value is the same as event_processors.FUNCTION.function_id. You can either define the value here or in event_processors.FUNCTION.function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define function_id, the backend duplicates it to event_processors.FUNCTION.function_id.

If you define function_id, event_processors is not required. You must provide either function_id or event_processors when updating a trigger.

function_name string

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as event_processors.FUNCTION.function_name. You can either define the value here or in event_processors.FUNCTION.function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define function_name, the backend duplicates it to event_processors.FUNCTION.function_name.

If you define function_name, event_processors is not required. You must provide either function_name or event_processors when updating a trigger.

event_processors object Required

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. For an example configuration object, see Send Trigger Events to AWS EventBridge.

Hide event_processors attributes Show event_processors attributes object

FUNCTION object

Hide FUNCTION attribute Show FUNCTION attribute object

config object

Hide config attributes Show config attributes object

function_id string

The ID of the function that the trigger calls when it fires.

This value is the same as the root-level function_id. You can either define the value here or in function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_id, the backend duplicates it to function_id.

If you define function_id, event_processors is not required. You must provide either function_id or event_processors when updating a trigger.

function_name string

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as the root-level function_name. You can either define the value here or in function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_name, the backend duplicates it to function_name.

If you define function_name, event_processors is not required. You must provide either function_name or event_processors when updating a trigger.

AWS_EVENTBRIDGE object

Hide AWS_EVENTBRIDGE attribute Show AWS_EVENTBRIDGE attribute object

config object

Hide config attributes Show config attributes object

account_id string

An AWS Account ID.

region string

An AWS region.

extended_json_enabled boolean

If true, event objects are serialized using EJSON.

Default value is false.
Hide attributes Show attributes

_id string

The trigger's unique ID.

name string Required

The trigger's name.

type string Required

The trigger type. For scheduled triggers, this value is always "SCHEDULED".

Value is SCHEDULED.

disabled boolean

If true, the trigger is disabled and does not listen for events or execute.

Default value is false.

config object Required

An object that defines configuration values for the trigger.

Hide config attributes Show config attributes object

schedule string Required

A cron expression that specifies when the trigger executes.

skip_catchup_events boolean

If true, enabling the trigger after it was disabled will not invoke events that occurred while the trigger was disabled.

function_id string

The ID of the function that the trigger calls when it fires.

This value is the same as event_processors.FUNCTION.function_id. You can either define the value here or in event_processors.FUNCTION.function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define function_id, the backend duplicates it to event_processors.FUNCTION.function_id.

If you define function_id, event_processors is not required. You must provide either function_id or event_processors when updating a trigger.

function_name string

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as event_processors.FUNCTION.function_name. You can either define the value here or in event_processors.FUNCTION.function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define function_name, the backend duplicates it to event_processors.FUNCTION.function_name.

If you define function_name, event_processors is not required. You must provide either function_name or event_processors when updating a trigger.

event_processors object Required

An object where each field name is an event processor ID and each value is an object that configures its corresponding event processor. For an example configuration object, see Send Trigger Events to AWS EventBridge.

Hide event_processors attributes Show event_processors attributes object

FUNCTION object

Hide FUNCTION attribute Show FUNCTION attribute object

config object

Hide config attributes Show config attributes object

function_id string

The ID of the function that the trigger calls when it fires.

This value is the same as the root-level function_id. You can either define the value here or in function_id. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_id, the backend duplicates it to function_id.

If you define function_id, event_processors is not required. You must provide either function_id or event_processors when updating a trigger.

function_name string

The name of the function that the trigger calls when it fires, i.e. the function described by function_id.

This value is the same as the root-level function_name. You can either define the value here or in function_name. The App Services backend duplicates the value to the configuration location where you did not define it.

For example, if you define event_processors.FUNCTION.function_name, the backend duplicates it to function_name.

If you define function_name, event_processors is not required. You must provide either function_name or event_processors when updating a trigger.

AWS_EVENTBRIDGE object

Hide AWS_EVENTBRIDGE attribute Show AWS_EVENTBRIDGE attribute object

config object

Hide config attributes Show config attributes object

account_id string

An AWS Account ID.

region string

An AWS region.

extended_json_enabled boolean

If true, event objects are serialized using EJSON.

Default value is false.
Hide attributes Show attributes

_id string

name string

type string

Value is SYNCTRANSLATOR.

function_id string

disabled boolean

config null

last_modified number

GET /groups/{groupId}/apps/{appId}/event_subscriptions/{eventSubscriptionId}

curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/event_subscriptions/{eventSubscriptionId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "name": "onNewEmployee",
  "type": "DATABASE",
  "config": {
    "match": {},
    "project": {},
    "database": "HR",
    "collection": "employees",
    "service_id": "5adeb649b8b998486770ae7c",
    "full_document": true,
    "operation_types": [
      "INSERT"
    ]
  },
  "function_id": "5eea9ca4ca0e356e2c2a148a",
  "event_processors": {
    "FUNCTION": {
      "config": {
        "function_id": "6841b8d3e71dc81bed89dbba",
        "function_name": "Atlas_Triggers_DatabaseInsert_1749137618"
      }
    }
  }
}

{
  "name": "onNewApiKey",
  "type": "AUTHENTICATION",
  "config": {
    "providers": [
      "api-key"
    ],
    "operation_type": "CREATE"
  },
  "function_id": "5eea9ca4ca0e356e2c2a148a",
  "event_processors": {
    "FUNCTION": {
      "config": {
        "function_id": "6841b8d3e71dc81bed89dbba",
        "function_name": "Atlas_Triggers_Auth_Create_1749137618"
      }
    }
  }
}

{
  "name": "createDailyReport",
  "type": "SCHEDULED",
  "config": {
    "schedule": "0 8 * * *"
  },
  "function_id": "5eea9ca4ca0e356e2c2a148a",
  "event_processors": {
    "FUNCTION": {
      "config": {
        "function_id": "6841b8d3e71dc81bed89dbba",
        "function_name": "Atlas_Triggers_Monthly_1749137618"
      }
    }
  }
}

{
  "_id": "636c189a93daaf89c4900a81",
  "name": "SyncTranslator",
  "type": "SYNCTRANSLATOR",
  "config": null,
  "disabled": false,
  "function_id": "000000000000000000000000",
  "last_modified": 1668028570
}