API : PBX : Events Update

A PBX event is a rule that runs actions - a webhook, an SMS, a call, setting a variable or a switch, or changing the members of a queue - when something happens on the PBX. See PBX events for the triggers, the variables and the limits.

This request will update an event. All properties are optional, and a property that is left out keeps its value:

• The action objects (webhook, sms, call, setVariable, setSwitch, queue) are merged into the ones the event has, so { webhook: { url: 'https://hooks.example.com/v2' } } changes only the URL. null removes the action, and so does an empty main property: webhook.url, sms.recipients, call.destination, setVariable.target, setSwitch.target or queue.action.
• target null or empty removes the limit. For type, enabled, timers and notes, null keeps the value.
• webhook.secret left out, null or empty keeps the secret. Use Secret to have a new one generated.
• Changing type to anything but TIMER removes the timers, and the target must fit the new type - and so must a TRIGGER in the queue action.
• The queue action keeps only what its action uses: with anything but JOIN it has no priority and exclusive, and with LEAVE_ALL no queue.
• The customer of an event cannot be changed. Properties that cannot be set, such as _id, customer, createdAt and updatedAt, are ignored - so the event can be sent back as Get returned it.

The event is checked as a whole after the change, with the same rules as when it is created.

{
  enabled: false
}

{
  webhook: {
    url: 'https://hooks.example.com/pbx/v2'
  },
  sms: null
}

{
  queue: {
    priority: 5,
    exclusive: true
  }
}

The updated event, in the same format as Get - including the webhook secret.