Developers

Make a key for another system

1. Press Create key.
2. Type a Name that says what uses it, such as Payroll provider sync.
3. Choose the unit it Reaches: that unit and every unit beneath it. Choose the top unit for the whole organization.
4. Under What it may reach, check only what the other system needs.
5. Choose how long it lasts in Ends after: a year unless you choose less.
6. Press Make the key and confirm it's you.
7. Copy the key into the other system's secrets, and press I have copied it.

Then: The key is shown this once. Its line shows who made it, where it reaches, when it ends and when it was last used, and every Owner and Admin is emailed. Of what a key does, each change and each refusal is in the audit log; reads are counted, by key and day, for 90 days.

Rather not? Send whoever builds the other system the reference, the link at the top of the keys' card: what a key can ask for, and each message ORG-APP sends.

Northfield's payroll provider needs names and roles. Daniel makes a key named Payroll provider sync, reaching the top unit, with People checked and nothing else, and pastes it into the provider's settings before pressing I have copied it.

Revoke a key, or take an old one off the list

1. Find the key by its name.
2. Press Revoke at the end of its row, then Revoke it.
3. To tidy the list, press Remove at the end of a key that no longer works, then Remove it.

Then: A revoked key is refused from its next call, and its line says Revoked. A removed key leaves the list; the audit log keeps its history.

Rather not? Make a new key first, put it in the other system, then revoke the old one, so nothing stops in between.

Tell your own system when something happens

1. Press the second card's button that adds an address.
2. Type the https address of your system under Address.
3. Type what it is for in What it is for (optional).
4. Choose the unit under From: what happens there and beneath it is sent.
5. Check what to send under Events to send, such as A person joined or A booking was made.
6. Press the button at the foot of the form and confirm it's you.
7. Copy the signing secret into your system, and press I have copied it.

Then: The address is listed with what it hears and how its week went, and every Owner and Admin is emailed. Each message says what happened and to which record, never a name: your system reads the record with a key, and checks the message came from ORG-APP with the signing secret.

Rather not? Press Pause to stop sending for a while and Turn back on to start again, New signing secret to replace the secret (the old one signs nothing from then), or Remove, then Remove it, to remove the address with its delivery log.

Sokha's ticketing system should hear when a task is done. They add its address, choose the top unit, check A task was done, and paste the signing secret into the system's settings.

Send a test and read the delivery log

1. Press Send a test on the address.
2. Read its line in the delivery log below: when, what was sent, the answer, how long it took and which attempt it was.

Then: The page says a test is on its way. A message your system does not take is tried again, 6 times in all over about twelve hours, and the log says when the next try is. The log shows the latest fifty, and deliveries are kept 30 days.

If an address says Stopped

1. Find the address marked Stopped: it failed for a day.
2. Fix the system that receives the messages.
3. Press Turn back on.
4. Press Send a test and read its line in the delivery log.

Then: It starts afresh: what happens from then on is sent to it. What ended while it was stopped is not sent again; your system reads what it missed with a key.