Event Trigger API
Event Triggers are a way for a customer to integrate their own systems with the Mashery service. They enable a customer to receive data when particular events happen in the Mashery service, such as a developer registering, an application being created, or the limits changed on a developer's key.
The Event Trigger API consists of HTTP-based calls that the Mashery service will make to a designated customer-hosted endpoint, e.g. http://mycustomerdomain.com/masherycallbacks. These calls are made after executing administration operations, such as create, update and delete, for the following Mashery objects: Member, Application, Key and Package Key. Put another way: event trigger API calls are made after the data is saved in the Mashery database.
NOTE: The customer-hosted endpoint must support additional path elements as well as query parameters, both of which are documented on each object's detail documentation page. The entry for the customer-hosted endpoint, as entered into the Mashery API Admin Console, is simply the root of the API that will be called. An example of what call would be produced when generating an event trigger for updating a Mashery member object is show below.
http://mycustomerdomain.com/masherycallbacks/v1/member/123456
The below table summarizes the event triggers supported by Mashery.
NOTE: Event Triggers are setup and managed by Mashery Support. Please contact support@mashery.com for assistance.
Object |
Event | HTTP Request Type of Call made to Customer-hosted Endpoint |
Data Sent to Customer-hosted Endpoint |
Data Returned from Customer-hosted Endpoint |
Member | Create | PUT | Member JSON or application/x-www-form-urlencoded data |
Member JSON |
Update | PUT | |||
Delete | DELETE | |||
Application | Create | PUT | Application JSON or application/x-www-form-urlencoded data | Application JSON |
Update | PUT | |||
Delete | DELETE | |||
Key | Create | PUT | Key JSON or application/x-www-form-urlencoded data | Key JSON |
Update | PUT | |||
Delete | DELETE | |||
Package Key | Create | PUT | Package Key JSON or application/x-www-form-urlencoded data | Package Key JSON |
Update | PUT | |||
Delete | DELETE |
Docs Navigation
- API Documentation Portal
- IO Docs Definition
- Mashery API Documentation
- Mashery 3.0 API Guide
- Mashery 2.0 API Guide
- OAuth Supporting Methods
- Examples
- JSON RPC
- Authentication
- API Objects
- Fetching Objects
- Query Language
- Creating Objects
- Updating Objects
- Validating Fields
- Deleting Objects
- Applications
- General Object Methods
- Members
- Packages
- Plans
- Package Keys
- Keys
- Developer Classes
- Services
- Roles
- Mashery 2.0 Reporting API Guide
- Event Trigger API
- Differences between Roles and Portal Access Groups
- Managing a Portal Access Group Using Mashery V2 or V3 API
- Mashery Reporting Event Post API Guide
- Tips and Tricks
- Your Portal
- API Traffic Manager
- I/O Docs WSDL requirements