Event

It is possible to be notified every time an event is created or modified at Ingresse. You just need to request Ingresse to add your webhook address into the system.

Event Webhooks

name	description
`event-create`	when a new event is created in the Backstage
`event-update`	when a event is updated in the Backstage

Once it is registered, every time one of those actions is performed, Ingresse will send a POST request with the following body message:

Webhook body message

key	description
`webhook`	the type of the hook related to the data
`data`	the content of the webhook
`timestamp`	the timestamp when the message was posted to destination

Examples

{
  "webhook": "event-create",
  "data": {
    "attributes": {
      "acceptedApps": {
        "name": "accepted_apps", 
        "value": null
      }, 
      "accountMode": {
        "name": "account_mode", 
        "value": false
      }, 
      "advertisement": {
        "name": "advertisement", 
        "value": {
          "mobile": {
            "background": null, 
            "cover": null, 
            "filter": null, 
            "ticket": null
          }, 
          "web": {
            "background": null, 
            "cover": null, 
            "filter": null, 
            "ticket": null
          }
        }
      }, 
      "cpfTicketsLimit": {
        "name": "cpf_tickets_limit", 
        "value": 3
      }, 
      "creditcardLimit": {
        "name": "creditcard_limit", 
        "value": 2
      }, 
      "customCode": {
        "name": "custom_code", 
        "value": false
      }, 
      "invoiceIdentifier": {
        "name": "invoice_identifier", 
        "value": null
      }, 
      "printData": {
        "name": "print_data", 
        "value": {
          "address": null, 
          "aiddp": "", 
          "complement": "", 
          "document": "", 
          "formalName": "", 
          "municipalId": ""
        }
      }, 
      "retentionPercentage": {
        "name": "retention_percentage", 
        "value": 1.5
      }, 
      "retentionThreshold": {
        "name": "retention_threshold", 
        "value": 100000.0
      }, 
      "saleEnabled": {
        "name": "sale_enabled", 
        "value": true
      }, 
      "ticketTransferEnabled": {
        "name": "ticket_transfer_enabled", 
        "value": true
      }, 
      "ticketTransferRequired": {
        "name": "ticket_transfer_required", 
        "value": false
      }, 
      "videoUrl": {
        "name": "video_url", 
        "value": null
      }
    }, 
    "categories": [], 
    "companyId": 1, 
    "createdAt": "2018-03-06T20:49:04.468967+00:00", 
    "description": "Lorem ipsum dolor sit amet", 
    "id": 21447, 
    "place": {
      "city": null, 
      "country": null, 
      "externalId": "174195295973440", 
      "id": 13970, 
      "location": {
        "lat": -10.59, 
        "lon": -37.38
      }, 
      "name": "Sergipe", 
      "origin": "facebook", 
      "state": null, 
      "street": null, 
      "zip": null
    }, 
    "poster": {
      "large": "https://event-kraken.s3.amazonaws.com/event/posters/21447/large.jpg", 
      "medium": "https://event-kraken.s3.amazonaws.com/event/posters/21447/medium.jpg", 
      "small": "https://event-kraken.s3.amazonaws.com/event/posters/21447/small.jpg", 
      "xLarge": "https://event-kraken.s3.amazonaws.com/event/posters/21447/xLarge.jpg"
    }, 
    "producerId": 297229, 
    "sessions": [
      {
        "dateTime": "2017-12-01T20:00:00+00:00", 
        "id": 32864, 
        "status": "finished"
      }
    ], 
    "slug": "webhook-example", 
    "status": {
      "id": 3, 
      "name": "private"
    },
    "title": "Webhook Example", 
    "updatedAt": "2018-03-06T20:49:04.468974+00:00", 
    "usersPermission": null
  },
  "timestamp": "2018-04-02T13:57:04.770619"
}

{
  "webhook": "event-update",
  "data": {
    "attributes": {
      "acceptedApps": {
        "name": "accepted_apps", 
        "value": null
      }, 
      "accountMode": {
        "name": "account_mode", 
        "value": false
      }, 
      "advertisement": {
        "name": "advertisement", 
        "value": {
          "mobile": {
            "background": null, 
            "cover": null, 
            "filter": null, 
            "ticket": null
          }, 
          "web": {
            "background": null, 
            "cover": null, 
            "filter": null, 
            "ticket": null
          }
        }
      }, 
      "cpfTicketsLimit": {
        "name": "cpf_tickets_limit", 
        "value": 3
      }, 
      "creditcardLimit": {
        "name": "creditcard_limit", 
        "value": 2
      }, 
      "customCode": {
        "name": "custom_code", 
        "value": false
      }, 
      "invoiceIdentifier": {
        "name": "invoice_identifier", 
        "value": null
      }, 
      "printData": {
        "name": "print_data", 
        "value": {
          "address": null, 
          "aiddp": "", 
          "complement": "", 
          "document": "", 
          "formalName": "", 
          "municipalId": ""
        }
      }, 
      "retentionPercentage": {
        "name": "retention_percentage", 
        "value": 1.5
      }, 
      "retentionThreshold": {
        "name": "retention_threshold", 
        "value": 100000.0
      }, 
      "saleEnabled": {
        "name": "sale_enabled", 
        "value": true
      }, 
      "ticketTransferEnabled": {
        "name": "ticket_transfer_enabled", 
        "value": true
      }, 
      "ticketTransferRequired": {
        "name": "ticket_transfer_required", 
        "value": false
      }, 
      "videoUrl": {
        "name": "video_url", 
        "value": null
      }
    }, 
    "categories": [], 
    "companyId": 1, 
    "createdAt": "2018-03-06T20:49:04.468967+00:00", 
    "description": "Lorem ipsum dolor sit amet", 
    "id": 21447, 
    "place": {
      "city": null, 
      "country": null, 
      "externalId": "174195295973440", 
      "id": 13970, 
      "location": {
        "lat": -10.59, 
        "lon": -37.38
      }, 
      "name": "Sergipe", 
      "origin": "facebook", 
      "state": null, 
      "street": null, 
      "zip": null
    }, 
    "poster": {
      "large": "https://event-kraken.s3.amazonaws.com/event/posters/21447/large.jpg", 
      "medium": "https://event-kraken.s3.amazonaws.com/event/posters/21447/medium.jpg", 
      "small": "https://event-kraken.s3.amazonaws.com/event/posters/21447/small.jpg", 
      "xLarge": "https://event-kraken.s3.amazonaws.com/event/posters/21447/xLarge.jpg"
    }, 
    "producerId": 297229, 
    "sessions": [
      {
        "dateTime": "2017-12-01T20:00:00+00:00", 
        "id": 32864, 
        "status": "finished"
      }
    ], 
    "slug": "webhook-example", 
    "status": {
      "id": 3, 
      "name": "private"
    }, 
    "title": "Webhook Example", 
    "updatedAt": "2018-03-06T20:49:04.468974+00:00", 
    "usersPermission": null
  },
  "timestamp": "2018-04-02T13:57:08.226707"
}